Skip to content

Add example PEP 723 Inline script metadata #266

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
johnthagen merged 1 commit into from
Apr 8, 2025
Merged

Add example PEP 723 Inline script metadata #266

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -403,6 +403,25 @@ The proper [shebang](https://en.wikipedia.org/wiki/Shebang_(Unix)) line for Pyth
#!/usr/bin/env python3
```

If your script has external dependencies hosted on PyPI, add
[PEP 723 Inline script metadata](https://peps.python.org/pep-0723/) and a `uv run` shebang line
to allow easy execution on macOS and Linux.

```py
#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.13"
# dependencies = [
# "httpx>=0.28.1",
# ]
# ///

import httpx
print(httpx.get("https://example.com").text)
```

On Windows, remove the `-S` from the shebang and execute the script using the `py` launcher.

## Package Dependency Tree

`uv tree` is a command for listing installed packages in the form of a dependency tree. For large
Expand Down