Table of Contents¶

twine upload¶

Uploads one or more distributions to a repository.

$ twine upload -h
usage: twine upload [-h] [-r REPOSITORY] [--repository-url REPOSITORY_URL]


                    [-s] [--sign-with SIGN_WITH] [-i IDENTITY] [-u USERNAME]


                    [-p PASSWORD] [-c COMMENT] [--config-file CONFIG_FILE]


                    [--skip-existing] [--cert path] [--client-cert path]


                    [--verbose] [--disable-progress-bar]


                    dist [dist ...]
positional arguments:


  dist                  The distribution files to upload to the repository


                        (package index). Usually dist/* . May additionally


                        contain a .asc file to include an existing signature


                        with the file upload.
optional arguments:


  -h, --help            show this help message and exit


  -r REPOSITORY, --repository REPOSITORY


                        The repository (package index) to upload the package


                        to. Should be a section in the config file (default:


                        pypi). (Can also be set via TWINE_REPOSITORY


                        environment variable.)


  --repository-url REPOSITORY_URL


                        The repository (package index) URL to upload the


                        package to. This overrides --repository. (Can also be


                        set via TWINE_REPOSITORY_URL environment variable.)


  -s, --sign            Sign files to upload using GPG.


  --sign-with SIGN_WITH


                        GPG program used to sign uploads (default: gpg).


  -i IDENTITY, --identity IDENTITY


                        GPG identity used to sign files.


  -u USERNAME, --username USERNAME


                        The username to authenticate to the repository


                        (package index) as. (Can also be set via


                        TWINE_USERNAME environment variable.)


  -p PASSWORD, --password PASSWORD


                        The password to authenticate to the repository


                        (package index) with. (Can also be set via


                        TWINE_PASSWORD environment variable.)


  --non-interactive     Do not interactively prompt for username/password


                        if the required credentials are missing. (Can also


                        be set via TWINE_NON_INTERACTIVE environment


                        variable.)


  -c COMMENT, --comment COMMENT


                        The comment to include with the distribution file.


  --config-file CONFIG_FILE


                        The .pypirc config file to use.


  --skip-existing       Continue uploading files if one already exists. (Only


                        valid when uploading to PyPI. Other implementations


                        may not support this.)


  --cert path           Path to alternate CA bundle (can also be set via


                        TWINE_CERT environment variable).


  --client-cert path    Path to SSL client certificate, a single file


                        containing the private key and the certificate in PEM


                        format.


  --verbose             Show verbose output.


  --disable-progress-bar


                        Disable the progress bar.

twine check¶

Checks whether your distribution’s long description will render correctly on PyPI.

$ twine check -h
usage: twine check [-h] [--strict] dist [dist ...]
positional arguments:


  dist        The distribution files to check, usually dist/*
optional arguments:


  -h, --help  show this help message and exit


  --strict    Fail on warnings

twine register¶

WARNING: The register command is no longer necessary if you are uploading to pypi.org. As such, it is no longer supported in Warehouse (the new PyPI software running on pypi.org). However, you may need this if you are using a different package index.

For completeness, its usage:

$ twine register -h
usage: twine register [-h] -r REPOSITORY [--repository-url REPOSITORY_URL]


                      [-u USERNAME] [-p PASSWORD] [-c COMMENT]


                      [--config-file CONFIG_FILE] [--cert path]


                      [--client-cert path]


                      package
positional arguments:


  package               File from which we read the package metadata.
optional arguments:


  -h, --help            show this help message and exit


  -r REPOSITORY, --repository REPOSITORY


                        The repository (package index) to register the package


                        to. Should be a section in the config file. (Can also


                        be set via TWINE_REPOSITORY environment variable.)


                        Initial package registration no longer necessary on


                        pypi.org:


                        https://packaging.python.org/guides/migrating-to-pypi-


                        org/


  --repository-url REPOSITORY_URL


                        The repository (package index) URL to register the


                        package to. This overrides --repository. (Can also be


                        set via TWINE_REPOSITORY_URL environment variable.)


  -u USERNAME, --username USERNAME


                        The username to authenticate to the repository


                        (package index) as. (Can also be set via


                        TWINE_USERNAME environment variable.)


  -p PASSWORD, --password PASSWORD


                        The password to authenticate to the repository


                        (package index) with. (Can also be set via


                        TWINE_PASSWORD environment variable.)


  --non-interactive     Do not interactively prompt for username/password


                        if the required credentials are missing. (Can also


                        be set via TWINE_NON_INTERACTIVE environment


                        variable.)


  -c COMMENT, --comment COMMENT


                        The comment to include with the distribution file.


  --config-file CONFIG_FILE


                        The .pypirc config file to use.


  --cert path           Path to alternate CA bundle (can also be set via


                        TWINE_CERT environment variable).


  --client-cert path    Path to SSL client certificate, a single file


                        containing the private key and the certificate in PEM


                        format.

Environment Variables¶

Twine also supports configuration via environment variables. Options passed on the command line will take precedence over options set via environment variables. Definition via environment variable is helpful in environments where it is not convenient to create a .pypirc file (for example, on a CI/build server).

Disabling Keyring¶

In most cases, simply not setting a password with keyring will allow Twine to fall back to prompting for a password. In some cases, the presence of Keyring will cause unexpected or undesirable prompts from the backing system. In these cases, it may be desirable to disable Keyring altogether. To disable Keyring, simply invoke:

$ keyring --disable

or

$ python -m keyring --disable

That command will configure for the current user the “null” keyring, effectively disabling the functionality, and allowing Twine to prompt for passwords.

See twine 338 for discussion and background.

Contributing¶

We are happy you have decided to contribute to twine.

Please see the GitHub repository for code and more documentation, and the official Python Packaging User Guide for user documentation. To ask questions or get involved, you can join the Python Packaging Discourse forum, #pypa or #pypa-dev on IRC, or the distutils-sig mailing list.

Getting started¶

We use tox to run tests, check code style, and build the documentation. To install tox, run:

python3 -m pip install tox

Clone the twine repository from GitHub, then run:

cd /path/to/your/local/twine
tox -e dev

This creates a virtual environment, so that twine and its dependencies do not interfere with other packages installed on your machine. In the virtual environment, twine is pointing at your local copy, so when you make changes, you can easily see their effect.

The virtual environment also contains the tools for running tests and checking code style, so you can run them on single files directly or in your code editor. However, we still encourage using the tox commands below on the whole codebase.

To use the virtual environment, run:

source venv/bin/activate

Building the documentation¶

Additions and edits to twine’s documentation are welcome and appreciated.

To preview the docs while you’re making changes, run:

tox -e watch-docs

Then open a web browser to http://127.0.0.1:8000.

When you’re done making changes, lint and build the docs locally before making a pull request. In your active virtual environment, run:

tox -e docs

The HTML of the docs will be written to docs/_build/html.

Code style¶

To automatically reformat your changes with isort and black, run:

tox -e format

To detect any remaining code smells with flake8, run:

tox -e lint

To perform strict type-checking using mypy, run:

tox -e types

Any errors from lint or types need to be fixed manually.

Additionally, we prefer that import statements be used for packages and modules only, rather than individual classes or functions.

Testing¶

We use pytest for writing and running tests.

To run the tests in your virtual environment, run:

tox -e py

To pass options to pytest, e.g. the name of a test, run:

tox -e py -- tests/test_upload.py::test_exception_for_http_status

Twine is continuously tested against Python 3.6, 3.7, 3.8, and 3.9 using GitHub Actions. To run the tests against a specific version, e.g. Python 3.6, you will need it installed on your machine. Then, run:

tox -e py36

To run the “integration” tests of uploading to real package indexes, run:

tox -e integration

To run the tests against all supported Python versions, check code style, and build the documentation, run:

tox

Submitting changes¶

Changelog entries¶

The docs/changelog.rst file is built by towncrier from files in the changelog/ directory. To add an entry, create a file in that directory named {number}.{type}.rst, where {number} is the pull request number, and {type} is feature, bugfix, doc, removal, or misc.

For example, if your PR number is 1234 and it’s fixing a bug, then you would create changelog/1234.bugfix.rst. PRs can span multiple categories by creating multiple files: if you added a feature and deprecated/removed an old feature in PR #5678, you would create changelog/5678.feature.rst and changelog/5678.removal.rst.

A changelog entry is meant for end users and should only contain details relevant to them. In order to maintain a consistent style, please keep the entry to the point, in sentence case, shorter than 80 characters, and in an imperative tone. An entry should complete the sentence “This change will …”. If one line is not enough, use a summary line in an imperative tone, followed by a description of the change in one or more paragraphs, each wrapped at 80 characters and separated by blank lines.

You don’t need to reference the pull request or issue number in a changelog entry, since towncrier will add a link using the number in the file name, and the pull request should reference an issue number. Similarly, you don’t need to add your name to the entry, since that will be associated with the pull request.

Changelog entries are rendered using reStructuredText, but they should only have minimal formatting (such as ``monospaced text``).

Architectural overview¶

Twine is a command-line tool for interacting with PyPI securely over HTTPS. Its three purposes are to be:

Currently, twine has two principle functions: uploading new packages and registering new projects (register is no longer supported on PyPI, and is in Twine for use with other package indexes).

Its command line arguments are parsed in twine/cli.py. The code for registering new projects is in twine/commands/register.py, and the code for uploading is in twine/commands/upload.py. The file twine/package.py contains a single class, PackageFile, which hashes the project files and extracts their metadata. The file twine/repository.py contains the Repository class, whose methods control the URL the package is uploaded to (which the user can specify either as a default, in the .pypirc file, or pass on the command line), and the methods that upload the package securely to a URL.

Where Twine gets configuration and credentials¶

A user can set the repository URL, username, and/or password via command line, .pypirc files, environment variables, and keyring.

Adding a maintainer¶

A checklist for adding a new maintainer to the project.

Making a new release¶

A checklist for creating, testing, and distributing a new version.

Future development¶

See our open issues.

In the future, pip and twine may merge into a single tool; see ongoing discussion.

Changelog¶

This project follows the semantic versioning and pre-release versioning schemes recommended by the Python Packaging Authority.

Twine 3.4.2 (2021-07-20)¶

Bugfixes¶

Twine 3.4.1 (2021-03-16)¶

Bugfixes¶

Twine 3.4.0 (2021-03-15)¶

Features¶

Twine 3.3.0 (2020-12-23)¶

Features¶

Bugfixes¶

Improved Documentation¶

Twine 3.2.0 (2020-06-24)¶

Features¶

Bugfixes¶

Twine 3.1.1 (2019-11-27)¶

Bugfixes¶

Twine 3.1.0 (2019-11-23)¶

Features¶

Twine 3.0.0 (2019-11-18)¶

Features¶

Bugfixes¶

Twine 2.0.0 (2019-09-24)¶

Features¶

Bugfixes¶

Twine 1.15.0 (2019-09-17)¶

Features¶

Twine 1.14.0 (2019-09-06)¶

Features¶

Bugfixes¶

Twine 1.13.0 (2019-02-13)¶

Features¶

Bugfixes¶

Misc¶

Twine 1.12.1 (2018-09-24)¶

Bugfixes¶

Twine 1.12.0 (2018-09-24)¶

Features¶

Bugfixes¶

Twine 1.11.0 (2018-03-19)¶

Features¶

Bugfixes¶

Misc¶

Twine 1.10.0 (2018-03-07)¶

Features¶

Bugfixes¶

Twine 1.9.1 (2017-05-27)¶

Bugfixes¶

Twine 1.9.0 (2017-05-22)¶

Bugfixes¶

Misc¶

Twine 1.8.1 (2016-08-09)¶

Misc¶

Twine 1.8.0 (2016-08-08)¶

Features¶

Misc¶

Twine 1.7.4 (2016-07-09)¶

Bugfixes¶

Twine 1.7.3 (2016-07-08)¶

Bugfixes¶

Misc¶

Twine 1.7.2 (2016-07-05)¶

Bugfixes¶

Twine 1.7.1 (2016-07-05)¶

Bugfixes¶

Twine 1.7.0 (2016-07-04)¶

Features¶

Bugfixes¶

Twine 1.6.5 (2015-12-16)¶

Bugfixes¶

Twine 1.6.4 (2015-10-27)¶

Bugfixes¶

Twine 1.6.3 (2015-10-05)¶

Bugfixes¶

Twine 1.6.2 (2015-09-28)¶

Bugfixes¶

Twine 1.6.1 (2015-09-18)¶

Bugfixes¶

Twine 1.6.0 (2015-09-14)¶

Features¶

Bugfixes¶

Twine 1.5.0 (2015-03-10)¶

Features¶

Bugfixes¶

Misc¶

Twine 1.4.0 (2014-12-12)¶

Features¶

Bugfixes¶

Twine 1.3.0 (2014-03-31)¶

Features¶

Twine 1.2.2 (2013-10-03)¶

Features¶