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.

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

doc: using keyring with API key #1119

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
9 changes: 3 additions & 6 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -192,20 +192,17 @@ require `additional installation steps`_.
Once Twine is installed, use the ``keyring`` program to set a username and
password to use for each repository to which you may upload.

For example, to set a username and password for PyPI:
For example, to set an API token for PyPI:

.. code-block:: bash

keyring set https://upload.pypi.org/legacy/ your-username
keyring set https://upload.pypi.org/legacy/ __token__

and enter the password when prompted.
and paste your API key when prompted.

For a different repository, replace the URL with the relevant repository
URL. For example, for Test PyPI, use ``https://test.pypi.org/legacy/``.

The next time you run ``twine``, it will prompt you for a username, and then
get the appropriate password from Keyring.

.. note::

If you are using Linux in a headless environment (such as on a
Expand Down
Loading