Skip to content
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

Jump to bottom

Add documentation of auto-included files in wheels and sdist #8555

Merged
merged 5 commits into from
Oct 23, 2023
Merged

Add documentation of auto-included files in wheels and sdist #8555

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4a4dae2
Add documentation of auto-included files in wheels and sdist
asikeero Oct 18, 2023
24a5e0d
Update wording for better format
asikeero Oct 20, 2023
9abac43
Update docs/libraries.md
asikeero Oct 23, 2023
9a88d79
Update docs/libraries.md
asikeero Oct 23, 2023
756413d
Merge branch 'master' into feature/document-licenses-addition
asikeero Oct 23, 2023
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
13 changes: 12 additions & 1 deletion docs/libraries.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,18 @@ poetry build
This command will package your library in two different formats: `sdist` which is
the source format, and `wheel` which is a `compiled` package.

Once that's done you are ready to publish your library
Poetry will automatically include some metadata files when building a package. When building
a wheel, the following files are included in the `.dist-info` directory:
asikeero marked this conversation as resolved.
Show resolved Hide resolved
- `LICENSE`
- `LICENSE.*`
- `COPYING`
- `COPYING.*`
- `LICENSES/**`

When building a sdist, the following files will be included in the root folder:
asikeero marked this conversation as resolved.
Show resolved Hide resolved
- `LICENSE*`

Once building is done you are ready to publish your library.

## Publishing to PyPI

Expand Down