The .pypirc file¶

A .pypirc file allows you to define the configuration for package indexes (referred to here as “repositories”), so that you don’t have to enter the URL, username, or password whenever you upload a package with twine or flit.

The .pypirc file SHOULD be UTF-8 encoded.

Tools that read or write .pypirc files may not function correctly if another character encoding is used.

The format (originally defined by the distutils package) is:

The distutils section defines an index-servers field that lists the name of all sections describing a repository.

Each section describing a repository defines three fields:

• repository: The URL of the repository.

• username: The registered username on the repository.

• password: The password that will used to authenticate the username.

Common configurations¶

Twine’s default configuration mimics a .pypirc with repository sections for PyPI and TestPyPI:

Twine will add additional configuration from $HOME/.pypirc, the command line, and environment variables to this default configuration.

Using a PyPI token¶

To set your API token for PyPI, you can create a $HOME/.pypirc similar to:

For TestPyPI, add a [testpypi] section, using the API token from your TestPyPI account.

Using another package index¶

To configure an additional repository, you’ll need to redefine the index-servers field to include the repository name. Here is a complete example of a $HOME/.pypirc for PyPI, TestPyPI, and a private repository: