Mirroring tool that implements the client (mirror) side of PEP 381
This is a PyPI mirror client according to
PEP 381 +
PEP 503 +
- bandersnatch >=6.0 implements PEP691
- bandersnatch >=4.0 supports Linux, MacOSX + Windows
bandersnatch maintainers are looking for more help! Please refer to our MAINTAINER documentation to see the roles and responsibilities. We would also ask you read our Mission Statement to ensure it aligns with your thoughts for this project.
- If interested contact @cooperlees
The following instructions will place the bandersnatch executable in a
- bandersnatch requires
>= Python 3.8.0
This will pull latest build. Please use a specific tag if desired.
- Docker image includes
/bandersnatch/src/runner.pyto periodically run a
/bandersnatch/src/runner.py --helpfor usage
- With docker, we recommend bind mounting in a read only
- Defaults to
- Defaults to
docker pull pypa/bandersnatch docker run pypa/bandersnatch bandersnatch --help
This installs the latest stable, released version.
python3 -m venv bandersnatch bandersnatch/bin/pip install bandersnatch bandersnatch/bin/bandersnatch --help
bandersnatch mirror- it will create an empty configuration file for you in
/etc/bandersnatch.confand adapt to your needs.
bandersnatch mirroragain. It will populate your mirror with the current status of all PyPI packages. Current mirror package size can be seen here: https://pypi.org/stats/
allowlistcan be created to cut down your mirror size. You might want to Analyze PyPI downloads to determine which packages to add to your list.
bandersnatch mirrorregularly to update your mirror with any intermediate changes.
Configure your webserver to serve the
web/ sub-directory of the mirror.
For PEP691 support we need to respect the format the client requests.
Note that it is a good idea to have your webserver publish the HTML index files correctly with UTF-8 as the charset. The index pages will work without it but if humans look at the pages the characters will end up looking funny.
Make sure that the webserver uses UTF-8 to look up unicode path names. nginx gets this right by default - not sure about others.
For more information visit out official documentation for instructions on how to use a NGINX example Docker Image.
If you are looking to an docker-compose example head over here
You need to set up one cron job to run the mirror itself.
Here's a sample that you could place in
LC_ALL=en_US.utf8 */2 * * * * root bandersnatch mirror |& logger -t bandersnatch[mirror]
This assumes that you have a
logger utility installed that will convert the
output of the commands to syslog entries.
SystemD Timers are also another alternative in today's modern world.
bandersnatch does not keep much local state in addition to the mirrored data.
In general you can just keep rerunning
bandersnatch mirror to make it fix
If you want to force bandersnatch to check everything against the master PyPI:
bandersnatch mirror --force-checkto move status files if they exist in your mirror directory in order get a full sync.
Be aware that full syncs likely take hours depending on PyPI's performance and your network latency and bandwidth.
bandersnatch delete --help- Allows you to specify package(s) to be removed from your mirror (dangerous)
bandersnatch verify --help- Crawls your repo and fixes any missed files + deletes any unowned files found (dangerous)
Case-sensitive filesystem needed
You need to run bandersnatch on a case-sensitive filesystem.
OS X natively does this OK even though the filesystem is not strictly case-sensitive and bandersnatch will work fine when running on OS X. However, tarring a bandersnatch data directory and moving it to, e.g. Linux with a case-sensitive filesystem will lead to inconsistencies. You can fix those by deleting the status files and have bandersnatch run a full check on your data.
Windows requires elevated prompt
Bandersnatch makes use of symbolic links. On Windows, this permission is turned off by default for non-admin users. In order to run bandersnatch on Windows either call it from an elevated command prompt (i.e. right-click, run-as Administrator) or give yourself symlink permissions in the group policy editor.
Many sub-directories needed
The PyPI has a quite extensive list of packages that we need to maintain in a flat directory. Filesystems with small limits on the number of sub-directories per directory can run into a problem like this:
2013-07-09 16:11:33,331 ERROR: Error syncing package: zweb@802449 OSError: [Errno 31] Too many links: '../pypi/web/simple/zweb'
Specifically we recommend to avoid using ext3. Ext4 and newer does not have the limitation of 32k sub-directories.
A bandersnatch static mirror is compatible only to the "static", cacheable parts of PyPI that are needed to support package installation. It does not support more dynamic APIs of PyPI that maybe be used by various clients for other purposes.
An example of an unsupported API is PyPI's XML-RPC interface, which is used when running
The bandersnatch project strives to:
- Mirror all static objects of the Python Package Index (https://pypi.org/)
- bandersnatch's main goal is to support the main global index to local syncing only
- This will allow organizations to have lower latency access to PyPI and save bandwidth on their WAN connections and more importantly the PyPI CDN
- Custom features and requests may be accepted if they can be of a plugin form
- e.g. refer to the
- e.g. refer to the
If you have questions or comments, please submit a bug report to https://github.com/pypa/bandersnatch/issues/new
- Discord: #bandersnatch now sit in the PyPA Discord server. To join visit https://discord.com/invite/pypa
Code of Conduct
Everyone interacting in the bandersnatch project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the PSF Code of Conduct.
This client is based on the original pep381client by Martin v. Loewis.
Richard Jones was very patient answering questions at PyCon 2013 and made the protocol more reliable by implementing some PyPI enhancements.
Christian Theune for creating and maintaining
bandersnatch for many years!
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for bandersnatch-6.5.0-py3-none-any.whl