[](https://github.com/ambv/black)
[](https://github.com/pypa/bandersnatch/actions)
[](https://codecov.io/github/pypa/bandersnatch)
[](http://bandersnatch.readthedocs.io/en/latest/?badge=latest)
[](https://pepy.tech/project/bandersnatch)
______________________________________________________________________
This is a PyPI mirror client according to `PEP 381` + `PEP 503` + `PEP 691`
<http://www.python.org/dev/peps/pep-0381/>.
- bandersnatch >=6.0 implements PEP691
- bandersnatch >=4.0 supports *Linux*, *MacOSX* + *Windows*
- [Documentation](https://bandersnatch.readthedocs.io/en/latest/)
**bandersnatch maintainers** are looking for more **help**! Please refer to our
[MAINTAINER](https://github.com/pypa/bandersnatch/blob/master/MAINTAINERS.md)
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
## Installation
The following instructions will place the bandersnatch executable in a
virtualenv under `bandersnatch/bin/bandersnatch`.
- bandersnatch **requires** `>= Python 3.8.0`
## Docker
This will pull latest build. Please use a specific tag if desired.
- Docker image includes `/bandersnatch/src/runner.py` to periodically
run a `bandersnatch mirror`
- Please `/bandersnatch/src/runner.py --help` for usage
- With docker, we recommend bind mounting in a read only `bandersnatch.conf`
- Defaults to `/conf/bandersnatch.conf`
```shell
docker pull pypa/bandersnatch
docker run pypa/bandersnatch bandersnatch --help
```
### pip
This installs the latest stable, released version.
```shell
python3 -m venv bandersnatch
bandersnatch/bin/pip install bandersnatch
bandersnatch/bin/bandersnatch --help
```
## Quickstart
- Run `bandersnatch mirror` - it will create an empty configuration file
for you in `/etc/bandersnatch.conf`.
- Review `/etc/bandersnatch.conf` and adapt to your needs.
- Run `bandersnatch mirror` again. 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/>
- A `blocklist` or `allowlist` can be created to cut down your mirror size.
You might want to [Analyze PyPI downloads](https://packaging.python.org/guides/analyzing-pypi-package-downloads/)
to determine which packages to add to your list.
- Run `bandersnatch mirror` regularly to update your mirror with any
intermediate changes.
### Webserver
Configure your webserver to serve the `web/` sub-directory of the mirror.
For PEP691 support we need to respect the format the client requests.
For an [nginx](https://www.nginx.com/) example, please look at our
[banderx](https://github.com/pypa/bandersnatch/tree/main/src/banderx)
docker container and [nginx.conf](https://github.com/pypa/bandersnatch/blob/main/src/banderx/nginx.conf)
example configuration.
- 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](https://bandersnatch.readthedocs.io/)
for instructions on how to use a NGINX example Docker Image.
If you are looking to an docker-compose example head over [here](https://github.com/pypa/bandersnatch/tree/main/src/bandersnatch_docker_compose)
### Cron jobs
You need to set up one cron job to run the mirror itself.
Here's a sample that you could place in `/etc/cron.d/bandersnatch`:
```cron
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](https://www.freedesktop.org/software/systemd/man/systemd.timer.html)
are also another alternative in today's modern world.
### Maintenance
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
errors.
If you want to force bandersnatch to check everything against the master PyPI:
- run `bandersnatch mirror --force-check` to 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.
#### Other Commands
- `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*)
### Operational notes
#### 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:
```console
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.
#### Client Compatibility
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](https://warehouse.readthedocs.io/api-reference/xml-rpc/), which is used when running `pip search`.
### Bandersnatch Mission
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 `blocklist` and `allowlist` plugins
### Contact
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](https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md).
### Kudos
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!
Raw data
{
"_id": null,
"home_page": "https://github.com/pypa/bandersnatch/",
"name": "bandersnatch",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "",
"author": "Christian Theune",
"author_email": "ct@flyingcircus.io",
"download_url": "https://files.pythonhosted.org/packages/ba/bc/d287ae91f235852fd139edc17271da47702a5f6b6e111e6dea0f670455ce/bandersnatch-6.5.0.tar.gz",
"platform": null,
"description": "[](https://github.com/ambv/black)\n[](https://github.com/pypa/bandersnatch/actions)\n[](https://codecov.io/github/pypa/bandersnatch)\n[](http://bandersnatch.readthedocs.io/en/latest/?badge=latest)\n[](https://pepy.tech/project/bandersnatch)\n\n______________________________________________________________________\n\nThis is a PyPI mirror client according to `PEP 381` + `PEP 503` + `PEP 691`\n<http://www.python.org/dev/peps/pep-0381/>.\n\n- bandersnatch >=6.0 implements PEP691\n- bandersnatch >=4.0 supports *Linux*, *MacOSX* + *Windows*\n- [Documentation](https://bandersnatch.readthedocs.io/en/latest/)\n\n**bandersnatch maintainers** are looking for more **help**! Please refer to our\n[MAINTAINER](https://github.com/pypa/bandersnatch/blob/master/MAINTAINERS.md)\ndocumentation to see the roles and responsibilities. We would also\nask you read our **Mission Statement** to ensure it aligns with your thoughts for\nthis project.\n\n- If interested contact @cooperlees\n\n## Installation\n\nThe following instructions will place the bandersnatch executable in a\nvirtualenv under `bandersnatch/bin/bandersnatch`.\n\n- bandersnatch **requires** `>= Python 3.8.0`\n\n## Docker\n\nThis will pull latest build. Please use a specific tag if desired.\n\n- Docker image includes `/bandersnatch/src/runner.py` to periodically\n run a `bandersnatch mirror`\n - Please `/bandersnatch/src/runner.py --help` for usage\n- With docker, we recommend bind mounting in a read only `bandersnatch.conf`\n - Defaults to `/conf/bandersnatch.conf`\n\n```shell\ndocker pull pypa/bandersnatch\ndocker run pypa/bandersnatch bandersnatch --help\n```\n\n### pip\n\nThis installs the latest stable, released version.\n\n```shell\npython3 -m venv bandersnatch\nbandersnatch/bin/pip install bandersnatch\nbandersnatch/bin/bandersnatch --help\n```\n\n## Quickstart\n\n- Run `bandersnatch mirror` - it will create an empty configuration file\n for you in `/etc/bandersnatch.conf`.\n- Review `/etc/bandersnatch.conf` and adapt to your needs.\n- Run `bandersnatch mirror` again. It will populate your mirror with the\n current status of all PyPI packages.\n Current mirror package size can be seen here: <https://pypi.org/stats/>\n- A `blocklist` or `allowlist` can be created to cut down your mirror size.\n You might want to [Analyze PyPI downloads](https://packaging.python.org/guides/analyzing-pypi-package-downloads/)\n to determine which packages to add to your list.\n- Run `bandersnatch mirror` regularly to update your mirror with any\n intermediate changes.\n\n### Webserver\n\nConfigure your webserver to serve the `web/` sub-directory of the mirror.\nFor PEP691 support we need to respect the format the client requests.\n\nFor an [nginx](https://www.nginx.com/) example, please look at our\n[banderx](https://github.com/pypa/bandersnatch/tree/main/src/banderx)\ndocker container and [nginx.conf](https://github.com/pypa/bandersnatch/blob/main/src/banderx/nginx.conf)\nexample configuration.\n\n- Note that it is a good idea to have your webserver publish the HTML index\n files correctly with UTF-8 as the charset. The index pages will work without\n it but if humans look at the pages the characters will end up looking funny.\n\n- Make sure that the webserver uses UTF-8 to look up unicode path names. nginx\n gets this right by default - not sure about others.\n\nFor more information visit out [official documentation](https://bandersnatch.readthedocs.io/)\nfor instructions on how to use a NGINX example Docker Image.\n\nIf you are looking to an docker-compose example head over [here](https://github.com/pypa/bandersnatch/tree/main/src/bandersnatch_docker_compose)\n\n### Cron jobs\n\nYou need to set up one cron job to run the mirror itself.\n\nHere's a sample that you could place in `/etc/cron.d/bandersnatch`:\n\n```cron\n LC_ALL=en_US.utf8\n */2 * * * * root bandersnatch mirror |& logger -t bandersnatch[mirror]\n```\n\nThis assumes that you have a `logger` utility installed that will convert the\noutput of the commands to syslog entries.\n\n[SystemD Timers](https://www.freedesktop.org/software/systemd/man/systemd.timer.html)\nare also another alternative in today's modern world.\n\n### Maintenance\n\nbandersnatch does not keep much local state in addition to the mirrored data.\nIn general you can just keep rerunning `bandersnatch mirror` to make it fix\nerrors.\n\nIf you want to force bandersnatch to check everything against the master PyPI:\n\n- run `bandersnatch mirror --force-check` to move status files if they exist in your mirror directory in order get a full sync.\n\nBe aware that full syncs likely take hours depending on PyPI's performance and your network latency and bandwidth.\n\n#### Other Commands\n\n- `bandersnatch delete --help` - Allows you to specify package(s) to be removed from your mirror (*dangerous*)\n- `bandersnatch verify --help` - Crawls your repo and fixes any missed files + deletes any unowned files found (*dangerous*)\n\n### Operational notes\n\n#### Case-sensitive filesystem needed\n\nYou need to run bandersnatch on a case-sensitive filesystem.\n\nOS X natively does this OK even though the filesystem is not strictly\ncase-sensitive and bandersnatch will work fine when running on OS X. However,\ntarring a bandersnatch data directory and moving it to, e.g. Linux with a\ncase-sensitive filesystem will lead to inconsistencies. You can fix those by\ndeleting the status files and have bandersnatch run a full check on your data.\n\n#### Windows requires elevated prompt\n\nBandersnatch 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.\n\n#### Many sub-directories needed\n\nThe PyPI has a quite extensive list of packages that we need to maintain in a\nflat directory. Filesystems with small limits on the number of sub-directories\nper directory can run into a problem like this:\n\n```console\n 2013-07-09 16:11:33,331 ERROR: Error syncing package: zweb@802449\n OSError: [Errno 31] Too many links: '../pypi/web/simple/zweb'\n```\n\nSpecifically we recommend to avoid using ext3. Ext4 and newer does not have the\nlimitation of 32k sub-directories.\n\n#### Client Compatibility\n\nA bandersnatch static mirror is compatible only to the \"static\", cacheable\nparts of PyPI that are needed to support package installation. It does not\nsupport more dynamic APIs of PyPI that maybe be used by various clients for\nother purposes.\n\nAn example of an unsupported API is [PyPI's XML-RPC interface](https://warehouse.readthedocs.io/api-reference/xml-rpc/), which is used when running `pip search`.\n\n### Bandersnatch Mission\n\nThe bandersnatch project strives to:\n\n- Mirror all static objects of the Python Package Index (<https://pypi.org/>)\n- bandersnatch's main goal is to support the main global index to local syncing **only**\n- This will allow organizations to have lower latency access to PyPI and\n save bandwidth on their WAN connections and more importantly the PyPI CDN\n- Custom features and requests may be accepted if they can be of a *plugin* form\n - e.g. refer to the `blocklist` and `allowlist` plugins\n\n### Contact\n\nIf you have questions or comments, please submit a bug report to\n<https://github.com/pypa/bandersnatch/issues/new>\n\n- Discord: #bandersnatch now sit in the *PyPA Discord* server. To join visit <https://discord.com/invite/pypa>\n\n### Code of Conduct\n\nEveryone interacting in the bandersnatch project's codebases, issue trackers,\nchat rooms, and mailing lists is expected to follow the\n[PSF Code of Conduct](https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md).\n\n### Kudos\n\nThis client is based on the original pep381client by *Martin v. Loewis*.\n\n*Richard Jones* was very patient answering questions at PyCon 2013 and made the\nprotocol more reliable by implementing some PyPI enhancements.\n\n*Christian Theune* for creating and maintaining `bandersnatch` for many years!\n",
"bugtrack_url": null,
"license": "Academic Free License, version 3",
"summary": "Mirroring tool that implements the client (mirror) side of PEP 381",
"version": "6.5.0",
"project_urls": {
"Change Log": "https://github.com/pypa/bandersnatch/blob/master/CHANGES.md",
"Homepage": "https://github.com/pypa/bandersnatch/",
"Source Code": "https://github.com/pypa/bandersnatch"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0dcd1f3d86a754f8ab4c671da9f2bc17167c67a2f8d6f99098c18d6d7e4e053a",
"md5": "9eaf683ac18c7cf37fff4a0286e83695",
"sha256": "f257df14759395226d3e54cb4c3414064ef9c7081199fb7b537e33def25e82d5"
},
"downloads": -1,
"filename": "bandersnatch-6.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9eaf683ac18c7cf37fff4a0286e83695",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 107022,
"upload_time": "2023-11-12T21:07:19",
"upload_time_iso_8601": "2023-11-12T21:07:19.446274Z",
"url": "https://files.pythonhosted.org/packages/0d/cd/1f3d86a754f8ab4c671da9f2bc17167c67a2f8d6f99098c18d6d7e4e053a/bandersnatch-6.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "babcd287ae91f235852fd139edc17271da47702a5f6b6e111e6dea0f670455ce",
"md5": "7072cee9a2c11aa3d32b0dbc3317d8a7",
"sha256": "561ec7c17f7565a804199585e0a456974f9d7c1710ca888439b01e4acee7d3a4"
},
"downloads": -1,
"filename": "bandersnatch-6.5.0.tar.gz",
"has_sig": false,
"md5_digest": "7072cee9a2c11aa3d32b0dbc3317d8a7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 90098,
"upload_time": "2023-11-12T21:07:21",
"upload_time_iso_8601": "2023-11-12T21:07:21.292387Z",
"url": "https://files.pythonhosted.org/packages/ba/bc/d287ae91f235852fd139edc17271da47702a5f6b6e111e6dea0f670455ce/bandersnatch-6.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-12 21:07:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pypa",
"github_project": "bandersnatch",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "bandersnatch"
}
JSON
