Skip to content

Commit

Permalink
Update index.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ZeroIntensity authored Apr 30, 2024
1 parent 9265d56 commit d34127e
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,15 @@ if __name__ == "__main__":
)
```

However, if you're distributing a library or something similar, then you want to specify PyAwaitable as a [build dependency](https://peps.python.org/pep-0517/#build-requirements):

```toml
# pyproject.toml example with setuptools
[build-system]
requires = ["setuptools", "pyawaitable"]
build-backend = "setuptools.build_meta"
```

!!! question "Why don't I have to add include or library directories?"

PyAwaitable only ships you a header file (which is stored in `$dataroot/include`, which is included by `setuptools` automatically. The header file then uses [capsules](https://docs.python.org/3/extending/extending.html#using-capsules) to load PyAwaitable and all of it's API functions.

0 comments on commit d34127e

Please sign in to comment.