Skip to content

updates @ packaging-projects.rst #1818

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.

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Conversation

cassiasamp
Copy link

@cassiasamp cassiasamp commented Feb 25, 2025

hi everyone, I was following the tutorial for packaging projects and thought that some details might help others.

This commit:

  • fixes raised value and configuration errors in pyproject.toml for hatchling;
  • makes explicit the creation of a LICENSE file (if I hadn't previous knowledge, it might be confusing);
  • adds TestPyPI installation example (package wasn't recognized with current's tutorial command).

📚 Documentation preview 📚: https://python-packaging-user-guide--1818.org.readthedocs.build/en/1818/

- fixed the raised value and configuration errors in pyproject.toml 
- made explicit the creation of a LICENSE file
- added TestPyPI installation example (package wasn't recognized with current's tutorial command)
Thank you @sinoroc. Accepting changes.

Co-authored-by: sinoroc <[email protected]>
Copy link
Author

@cassiasamp cassiasamp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @sinoroc. Accepting changes.

Comment on lines 489 to 493
In case there is an issue with the above instruction and the package isn't recognized, use the link provided at TestPyPI:

.. code-block:: bash

python3 -m pip install --index-url https://test.pypi.org/simple/ example-package-YOUR-USERNAME-HERE
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand; how does omitting --no-deps help work around this issue?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hi @chrysle ..is that question for me or @sinoroc?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's also dangerous to suggest this, as any other deps will be allowed from TestPyPI enabling supply chain attacks.

@@ -217,8 +217,7 @@ following this tutorial.
"Programming Language :: Python :: 3",
"Operating System :: OS Independent",
]
license = "MIT"
license-files = ["LICEN[CS]E*"]
license = { file = "LICENSE" }
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PEP 639 deprecates this syntax and uses this field for SPDX.

@webknjaz
Copy link
Member

webknjaz commented Jul 9, 2025

adds TestPyPI installation example (package wasn't recognized with current's tutorial command).

Sounds like you might've been attempting to access the project very soon after upload. (Test)PyPI has caching in place and new uploads might become available for consumption in 10 minutes. This has nothing to do with --no-deps.

Comment on lines 220 to 221
license = "MIT"
license-files = ["LICEN[CS]E*"]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's unclear what this change attempts to achieve. So far, it doesn't look acceptable.

cassiasamp and others added 2 commits July 14, 2025 11:21
Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>
Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>
@cassiasamp
Copy link
Author

I have made the requested changes @webknjaz ✌🏽

@webknjaz
Copy link
Member

Check the inline threads.

as explained earlier this syntax caused an error, but rolling back due to comments
@cassiasamp
Copy link
Author

it seems they are all checked, please let me know if there is an specific one I have missed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants