Skip to content

Improve dev onboarding and docs #160

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fpliger merged 7 commits into from
May 7, 2025
Merged

Improve dev onboarding and docs #160

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4b674ca
add more details around installing on virtualenv or conda environments
fpliger Apr 30, 2025
198a7c8
add instructions to run the pyscript command in dev
fpliger Apr 30, 2025
ac14832
add section about how to create a new release
fpliger Apr 30, 2025
32b979c
add section about how the release process works
fpliger Apr 30, 2025
da49eab
fix mispellings (enviroment and avaible)
fpliger May 6, 2025
70de351
pin the python version when creating the dev environment
fpliger May 6, 2025
9e50f53
add note on how to build the package whell locally
fpliger May 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
add more details around installing on virtualenv or conda environments
  • Loading branch information
@fpliger
fpliger committed Apr 30, 2025
commit 4b674ca47ffa08d774f87ee11d3b73ce9fc9b8d6
19 changes: 17 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,29 @@ git clone https://github.com/pyscript/pyscript.git
pip install --upgrade pip
```

Make a virtualenv and activate it:
Create a local enviroment with your enviroment manager of choice.
Copy link
Copy Markdown
Contributor

@madhur-tandon madhur-tandon May 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

enviroment --> environment


### Virtualenv

In case you choose Virtualenv, make a virtualenv and activate it using the following commands:

```shell
python -m venv .venv
source .venv/bin/activate
```

Install your local enviroment dependencies
### Conda

In case you choose to use conda, use the following commands:

```shell
conda create -n pyscript-cli python
Copy link
Copy Markdown
Contributor

@madhur-tandon madhur-tandon May 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can probably pin to a specific python version here

conda activate pyscript-cli
```

### Installation

Now that you have your environment set up and activated, install your local enviroment dependencies
Copy link
Copy Markdown
Contributor

@madhur-tandon madhur-tandon May 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

enviroment --> environment (the 2nd one)

Copy link
Copy Markdown
Contributor

@madhur-tandon madhur-tandon May 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like the typo is present in other parts of the README too, which are not touched in this PR


```shell
pip install -e ".[dev]"
Expand Down