From b6c04121ade9c4c6140f864fa6159232559d5e3f Mon Sep 17 00:00:00 2001 From: Olena Date: Mon, 29 May 2023 20:37:21 +0300 Subject: [PATCH 1/2] Emphasize permitted version format in packages for publication The patch adds mention in README that local version identifiers in packages don't allow publishing to PyPI/TestPyPI. Also, it suggests alternative local servers for using local version identifiers. Resolves #322 Co-authored-by: Sviatoslav Sydorenko --- README.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.rst b/README.rst index a48309c1..c0b4a24d 100644 --- a/README.rst +++ b/README.rst @@ -292,6 +292,15 @@ the tag. For Git projects, the version relies on `git describe `_, so you will see an additional ``g`` prepended to the ``{revision hash}``. +.. note:: + + According to `PEP 440 `_, + if a version includes a local component, the package cannot be published to public + package indexes like PyPI or TestPyPI. The disallowed version segments may + be seen in auto-publishing workflows or when a configuration mistake is made. + + However, some package indexes such as devpi or other alternatives allow local + versions. Local version identifiers must comply with PEP `PEP 440`_. Semantic Versioning (SemVer) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From bcb00a5005f1502ba7326a823f1903d0ed37f89c Mon Sep 17 00:00:00 2001 From: Olena <107187316+OlenaYefymenko@users.noreply.github.com> Date: Mon, 29 May 2023 22:43:38 +0300 Subject: [PATCH 2/2] Edit typo in README.rst Co-authored-by: Sviatoslav Sydorenko --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index c0b4a24d..f72d6ca5 100644 --- a/README.rst +++ b/README.rst @@ -300,7 +300,7 @@ so you will see an additional ``g`` prepended to the ``{revision hash}``. be seen in auto-publishing workflows or when a configuration mistake is made. However, some package indexes such as devpi or other alternatives allow local - versions. Local version identifiers must comply with PEP `PEP 440`_. + versions. Local version identifiers must comply with `PEP 440`_. Semantic Versioning (SemVer) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~