Skip to content
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.

Sign up for GitHub

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

updates @ packaging-projects.rst #1818

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

updates @ packaging-projects.rst #1818

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
add1888
update packaging-projects.rst
cassiasamp Feb 25, 2025
8b0d4c2
Apply suggestions from code review
cassiasamp Mar 4, 2025
1c1d50d
Merge branch 'main' into patch-1
cassiasamp Mar 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions source/tutorials/packaging-projects.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.


[project.urls]
Homepage = "https://github.com/pypa/sampleproject"
Expand Down Expand Up @@ -308,7 +307,7 @@ Creating a LICENSE
It's important for every package uploaded to the Python Package Index to include
a license. This tells users who install your package the terms under which they
can use your package. For help picking a license, see
https://choosealicense.com/. Once you have chosen a license, open
https://choosealicense.com/. Once you have chosen a license, create a file called :file:`LICENSE`, open
:file:`LICENSE` and enter the license text. For example, if you had chosen the
MIT license:

Expand Down Expand Up @@ -486,6 +485,14 @@ and install your package from TestPyPI:

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


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
Comment on lines +489 to +493
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.



.. tab:: Windows

.. code-block:: bat
Expand Down