Skip to content
This repository was archived by the owner on Apr 20, 2025. It is now read-only.

Commit f6086af

Browse files
committed
Document package publishing with 2FA + API keys
This project has been marked as "critical" on the Python Package Index, which has some implications on the way new versions should be published.
1 parent 76c0e69 commit f6086af

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,18 @@ poetry install
3737

3838
## Publishing a New Release
3939

40+
Since this project is considered critical on the Python Package Index,
41+
two-factor authentication is required. For uploading packages to PyPi, an API
42+
key is required; username+password will not work.
43+
44+
First, generate an API token at https://pypi.org/manage/account/token/. Then,
45+
use this token when publishing instead of your username and password.
46+
47+
As username, use `__token__`.
48+
As password, use the token itself, including the `pypi-` prefix.
49+
50+
See https://pypi.org/help/#apitoken for help using API tokens to publish.
51+
4052
```
4153
. ./.venv/bin/activate
4254
poetry publish --build

0 commit comments

Comments
 (0)