From 4a4dae2c13d5408592a4d179be8c14c112668532 Mon Sep 17 00:00:00 2001 From: Eero Asikainen <60272147+asikeero@users.noreply.github.com> Date: Wed, 18 Oct 2023 15:50:08 +0300 Subject: [PATCH 1/4] Add documentation of auto-included files in wheels and sdist --- docs/libraries.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/libraries.md b/docs/libraries.md index 5ebe373cc94..05b2f69f492 100644 --- a/docs/libraries.md +++ b/docs/libraries.md @@ -52,7 +52,17 @@ 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 +If present in the project root directory, Poetry will automatically include the following files: +- in the `.dist-info` directory of a `wheel`: + - `LICENSE` + - `LICENSE.*` + - `COPYING` + - `COPYING.*` + - `LICENSES/**` +- in the root of a `sdist`: + - `LICENSE*` + +Once this is done you are ready to publish your library. ## Publishing to PyPI From 24a5e0d2633f1ef073856c0749bb754cea9b2e11 Mon Sep 17 00:00:00 2001 From: Eero Asikainen <60272147+asikeero@users.noreply.github.com> Date: Fri, 20 Oct 2023 11:00:33 +0300 Subject: [PATCH 2/4] Update wording for better format --- docs/libraries.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/libraries.md b/docs/libraries.md index 05b2f69f492..91b6ce589f0 100644 --- a/docs/libraries.md +++ b/docs/libraries.md @@ -52,17 +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. -If present in the project root directory, Poetry will automatically include the following files: -- in the `.dist-info` directory of a `wheel`: - - `LICENSE` - - `LICENSE.*` - - `COPYING` - - `COPYING.*` - - `LICENSES/**` -- in the root of a `sdist`: +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: +- `LICENSE` +- `LICENSE.*` +- `COPYING` +- `COPYING.*` +- `LICENSES/**` + +When building a sdist, the following files will be included in the root folder: - `LICENSE*` -Once this is done you are ready to publish your library. +Once building is done you are ready to publish your library. ## Publishing to PyPI From 9abac43d38eb5e662109ec9ba294e0545fc027a4 Mon Sep 17 00:00:00 2001 From: Eero Asikainen <60272147+asikeero@users.noreply.github.com> Date: Mon, 23 Oct 2023 12:26:34 +0300 Subject: [PATCH 3/4] Update docs/libraries.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Randy Döring <30527984+radoering@users.noreply.github.com> --- docs/libraries.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/libraries.md b/docs/libraries.md index 91b6ce589f0..8924df12e19 100644 --- a/docs/libraries.md +++ b/docs/libraries.md @@ -53,7 +53,7 @@ This command will package your library in two different formats: `sdist` which i the source format, and `wheel` which is a `compiled` package. 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: +a `wheel`, the following files are included in the `.dist-info` directory: - `LICENSE` - `LICENSE.*` - `COPYING` From 9a88d79cd31b24341790c62781c8955f311f9e6c Mon Sep 17 00:00:00 2001 From: Eero Asikainen <60272147+asikeero@users.noreply.github.com> Date: Mon, 23 Oct 2023 12:26:45 +0300 Subject: [PATCH 4/4] Update docs/libraries.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Randy Döring <30527984+radoering@users.noreply.github.com> --- docs/libraries.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/libraries.md b/docs/libraries.md index 8924df12e19..6bda48c4b35 100644 --- a/docs/libraries.md +++ b/docs/libraries.md @@ -60,7 +60,7 @@ a `wheel`, the following files are included in the `.dist-info` directory: - `COPYING.*` - `LICENSES/**` -When building a sdist, the following files will be included in the root folder: +When building an `sdist`, the following files will be included in the root folder: - `LICENSE*` Once building is done you are ready to publish your library.