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
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
Prev Previous commit
Next Next commit
add instructions to run the pyscript command in dev
  • Loading branch information
@fpliger
fpliger committed Apr 30, 2025
commit 198a7c8da55c9ca9d67d38ea813e2e2311d1df3e
31 changes: 31 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,37 @@ After setting up your developer enviroment, you can run the tests with the follo
pytest .
```

# Running CLI Commands

Once the installation process is done, the `pyscript` CLI is avaible to be used once the environment has been
Copy link
Member

Choose a reason for hiding this comment

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

avaible --> available

activated. Simply run `pyscript` with the appropriate command. For instance, to see the list of commands:

```shell
>> pyscript --help

Usage: pyscript [OPTIONS] COMMAND [ARGS]...

Command Line Interface for PyScript.

╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --version Show project version and exit. │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ create Create a new pyscript project with the passed in name, creating a new directory in the current directory. Alternatively, use `--wrap` so as to embed a │
│ python file instead. │
│ run Creates a local server to run the app on the path and port specified. │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
```

or, to run a pyscript app:

```shell
>> pyscript run
Serving from /pyscript-example at port 8000. To stop, press Ctrl+C.
127.0.0.1 - - [30/Apr/2025 17:01:03] "GET / HTTP/1.1" 200 -
```

## Documentation

### Install the documentation dependencies
Expand Down