-
Notifications
You must be signed in to change notification settings - Fork 8
Create README for examples to make them simple to run #9
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.
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
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
0b2b51f
Create a README for examples to make them easy to run
axelknock d29d056
Fix spelling
axelknock 4748031
Simplify running instructions, refactor dependencies
axelknock f36efe6
Exclude examples from annotations rules, sort imports
axelknock 412a67d
Apply pyproject-fmt rules
axelknock File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,129 @@ | ||
| # Datastar Python SDK Examples | ||
|
|
||
| ## How to Run These Examples with `uv` | ||
|
|
||
| All of the examples here (except Django) include Inline Script Metadata (PEP 723), allowing them to be run with [uv](https://docs.astral.sh/uv/) without first installing dependencies. | ||
|
|
||
| The following commands assume you are running them from the root of the repository. | ||
|
|
||
| ### Django | ||
|
|
||
| We use the `--with` argument to declare dependencies to run our Django app. | ||
|
|
||
| ```sh | ||
| uv run --with django --with daphne ./examples/django/manage.py runserver | ||
| ``` | ||
|
|
||
| ### FastAPI | ||
|
|
||
| ```sh | ||
| uv run ./examples/fastapi/app.py | ||
| ``` | ||
|
|
||
| ### FastHTML | ||
|
|
||
| ```sh | ||
| uv run ./examples/fasthtml/simple.py | ||
| ``` | ||
|
|
||
| ```sh | ||
| uv run ./examples/fasthtml/advanced.py | ||
| ``` | ||
|
|
||
| ### Litestar | ||
|
|
||
| ```sh | ||
| uv run ./examples/litestar/app.py | ||
| ``` | ||
|
|
||
| ### Quart | ||
|
|
||
| ```sh | ||
| uv run ./examples/quart/app.py | ||
| ``` | ||
|
|
||
| ### Sanic | ||
|
|
||
| ```sh | ||
| uv run ./examples/sanic/app.py | ||
| ``` | ||
|
|
||
axelknock marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ## How to Run These Examples with `pip` | ||
|
|
||
| ### Setup | ||
|
|
||
| ```sh | ||
| python -m venv .venv | ||
| ``` | ||
|
|
||
| ```sh | ||
| source .venv/bin/activate | ||
| ``` | ||
|
|
||
| ### Django | ||
|
|
||
| ```sh | ||
| pip install . daphne django | ||
| ``` | ||
|
|
||
| ```sh | ||
| python ./examples/django/manage.py runserver | ||
| ``` | ||
|
|
||
| ### FastAPI | ||
|
|
||
| ```sh | ||
| pip install . uvicorn fastapi | ||
| ``` | ||
|
|
||
| ```sh | ||
| python ./examples/fastapi/app.py | ||
| ``` | ||
|
|
||
| ### FastHTML | ||
|
|
||
| ```sh | ||
| pip install . python-fasthtml | ||
| ``` | ||
|
|
||
| ```sh | ||
| python ./examples/fasthtml/simple.py | ||
| ``` | ||
|
|
||
| ```sh | ||
| pip install . python-fasthtml great-tables pandas polars | ||
| ``` | ||
|
|
||
| ```sh | ||
| python ./examples/fasthtml/advanced.py | ||
| ``` | ||
|
|
||
| ### Litestar | ||
|
|
||
| ```sh | ||
| pip install . uvicorn litestar | ||
| ``` | ||
|
|
||
| ```sh | ||
| python ./examples/litestar/app.py | ||
| ``` | ||
|
|
||
| ### Quart | ||
|
|
||
| ```sh | ||
| pip install . quart | ||
| ``` | ||
|
|
||
| ```sh | ||
| python ./examples/quart/app.py | ||
| ``` | ||
|
|
||
| ### Sanic | ||
|
|
||
| ```sh | ||
| pip install . sanic | ||
| ``` | ||
|
|
||
| ```sh | ||
| python ./examples/sanic/app.py | ||
| ``` | ||
axelknock marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.