Add instructions on how to use keyring #323
Conversation
Codecov Report
@@ Coverage Diff @@
## master #323 +/- ##
=======================================
Coverage 69.53% 69.53%
=======================================
Files 12 12
Lines 581 581
Branches 91 91
=======================================
Hits 404 404
Misses 150 150
Partials 27 27Continue to review full report at Codecov.
|
README.rst
Outdated
| .. code-block:: console | ||
|
|
||
| $ keyring set https://upload.pypi.org/legacy/ your-username | ||
| $ python3 -m keyring set https://upload.pypi.org/legacy/ your-username |
There was a problem hiding this comment.
Please include the "or" between these two lines as you did above.
| * ``TWINE_USERNAME`` - the username to use for authentication to the repository | ||
| * ``TWINE_PASSWORD`` - the password to use for authentication to the repository | ||
| * ``TWINE_USERNAME`` - the username to use for authentication to the repository. | ||
| * ``TWINE_PASSWORD`` - the password to use for authentication to the repository. | ||
| * ``TWINE_REPOSITORY`` - the repository configuration, either defined as a |
There was a problem hiding this comment.
For parallelism, could you add the ending period to all the items in this list?
|
|
||
| $ keyring set https://test.pypi.org/legacy/ your-username | ||
| # or | ||
| $ python3 -m keyring set https://test.pypi.org/legacy/ your-username |
There was a problem hiding this comment.
Can you find some way here to indicate that it'll ask you to input a password? And I have the same suggestion for line 116-117.
README.rst
Outdated
| python3-dbus``. See `Keyring's installation instructions`_ for more details. | ||
|
|
||
| Once keyring is installed you can use the ``keyring`` program to set your | ||
| username and password for Twine. |
There was a problem hiding this comment.
Nitpick: I'd phrase this as:
"set your package index (repository) username and password for Twine to use"
There was a problem hiding this comment.
Good call, I changed it even a bit more. LMK what you think.
Closes #277.
Helps pypa/packaging.python.org#297 and #11.