Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

updates @ packaging-projects.rst #1818

Open
wants to merge 3 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/

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
- 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)

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
Thank you @sinoroc. Accepting changes.

Co-authored-by: sinoroc <5529267+sinoroc@users.noreply.github.com>
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.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
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.

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

Successfully merging this pull request may close these issues.

4 participants