Skip to main content

pip2pi builds a PyPI-compatible package repository from pip requirements

Project description

pip2pi builds a PyPI-compatible package repository from pip requirements

PyPI can go down, package maintainers can remove old tarballs, and downloading tarballs can take a long time. pip2pi helps to alleviate these problems by making it blindingly simple to maintain a PyPI-compatible repository of packages your software depends on.

$ pip2pi --help

Adds packages PACKAGES to PyPI-compatible package index at TARGET.

If TARGET contains ':' it will be treated as a remote path. The
package index will be built locally and rsync will be used to copy
it to the remote host.

PIP_OPTIONS can be any options accepted by `pip install -d`, like
`--index-url` or `--no-use-wheel`.

For example, to create a remote index:

    $ pip2pi -r requirements.txt

To create a local index:

    $ pip2pi ~/Sites/packages/ foo==1.2

To pass arguments to pip:

    $ pip2pi ~/Sites/packages/ \
        --index-url \
        --no-use-wheel \
        -r requirements-base.txt \
        -r requirements-dev.txt \


  1. pip
  2. A requirements.txt file for your project (optional, but useful)
  3. An HTTP server (optional, but useful)


Install pip2pi:

$ pip install pip2pi

And create the directory which will contain the tarballs of required packages, preferably somewhere under your web server’s document root:

$ mkdir /var/www/packages/

Mirroring Packages

To mirror a package and all of its requirements, use pip2tgz:

$ pip2tgz packages/ foo==1.2
$ ls packages/

Note that pip2tgz passes package arguments directly to pip, so packages can be specified in any format that pip recognizes:

$ cat requirements.txt
$ pip2tgz packages/ -r requirements.txt bam-2.3/
$ ls packages/

Building a Package Index

A directory full of .tar.gz files can be turned into PyPI-compatible “simple” package index using the dir2pi command:

$ ls packages/
$ dir2pi packages/
$ find packages/

But that’s a lot of work…

If running two commands seems like too much work… Take heart! The pip2pi command will run both of them for you… And it will use rsync to copy the new packages and index to a remote host!

$ pip2pi foo==1.2
$ curl -I | head -n1
HTTP/1.1 200 OK

But that’s still too much work…

Take heart! Your shell’s alias command can help. Add an alias like this to your shell’s runtime configuration file (hint: ~/.bashrc or similar):

alias pip2acmeco="pip2pi"

Now updating your package index will be as simple as:

$ pip2acmeco foo==1.2 -r bar/requirements.txt

Using Your New Package Index

To use the new package index, pass the --index-url= argument to pip:

$ pip install --index-url= foo

Or, once it has been mirrored, prefix you requirements.txt with --index-url=...:

$ cat requirements.txt

Without a web server

You can use your package index offline, too:

$ pip install --index-url=file:///var/www/packages/simple foo==1.2

Some Tips

When installing packages from source via python install or python install, you may need to create a setup.cfg, which points to your package index. Here are some examples for an offline package index in your Windows, Linux, or Mac file system:

# Windows
# index_url = file:///C:/pip2pi/simple/

# Linux
# index_url = file:///home/myusername/.pip2pi/simple/

# Mac
index_url = file:///Users/myusername/.pip2pi/simple/

Note the triple /// after file: – two for the protocol, the third for the root of the local file system.


  • Mirror PyPI
  • Offline PyPI
  • Create offline PyPI mirror

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pip2pi, version 0.8.2
Filename, size File type Python version Upload date Hashes
Filename, size pip2pi-0.8.2-py2.py3-none-any.whl (10.8 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size pip2pi-0.8.2.tar.gz (10.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page