Skip to content

Commit 7e8b650

Browse files
committed
Show how to add third-party PyPI dependencies
Add an "Adding Dependencies" section to README and a guiding comment in pyproject.toml's dependencies list.
1 parent 38902a5 commit 7e8b650

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,18 @@ src/endstone_example/
5555
config.toml Default config (copied on first run)
5656
```
5757

58+
## Adding Dependencies
59+
60+
To use third-party packages from PyPI, add them to the `dependencies` list in `pyproject.toml`:
61+
62+
```toml
63+
[project]
64+
dependencies = ["requests>=2.31", "aiosqlite>=0.19"]
65+
```
66+
67+
Then run `uv sync` (or `pip install -e .`) to install them. They will be bundled automatically
68+
when you build the wheel.
69+
5870
## Install on a Server
5971

6072
```bash

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
55
[project]
66
name = "endstone-example"
77
dynamic = ["version"]
8-
dependencies = []
8+
dependencies = [] # Add third-party PyPI packages here, e.g. ["requests>=2.31"]
99
authors = [
1010
{ name = "Endstone Developers", email = "hello@endstone.dev" },
1111
]

0 commit comments

Comments
 (0)