pypa / pypa/packaging.python.org
Dist publishing guide should mention versioning restrictions
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.7k
- Forks
- 1.7k
- Avg merge
- 3d 12h
- Merged PRs (30d)
- 4
Description
It has a few paragraphs about local version identifiers https://packaging.python.org/guides/distributing-packages-using-setuptools/#local-version-identifiers where it has this not intended for publication phrase but doesn't clearly state that public indexes usually forbid local identifiers.
And uploading your project to PyPI section doesn't mention this: https://packaging.python.org/guides/distributing-packages-using-setuptools/#uploading-your-project-to-pypi
(It should probably advise using/integrating twine check before uploading dists)
P.S. Today I also suggested that twine check warns about this as well: https://github.com/pypa/twine/issues/430
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the linked sections on local version identifiers and uploading a project to PyPI. Verify how public indexes handle local identifiers and how twine check fits before upload. Done means both sections clearly state the restriction and recommend the relevant validation step.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100