{"author":null,"author_email":null,"bugtrack_url":null,"classifiers":["Development Status :: 5 - Production/Stable","Environment :: Web Environment","Intended Audience :: Developers","Intended Audience :: System Administrators","License :: OSI Approved :: BSD License","License :: OSI Approved :: zlib/libpng License","Operating System :: MacOS :: MacOS X","Operating System :: Microsoft :: Windows","Operating System :: OS Independent","Operating System :: POSIX","Programming Language :: Python :: 3","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.7","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9","Programming Language :: Python :: Implementation :: CPython","Programming Language :: Python :: Implementation :: PyPy","Topic :: Software Development :: Build Tools","Topic :: System :: Software Distribution"],"description":"![pypi server logo](docs/__resources__/pypiserver_logo.png)\n\n# [**pypiserver - minimal PyPI server for use with pip/easy_install**](#pypiserver)\n\n[![pypi badge](https://img.shields.io/pypi/v/pypiserver.svg)](https://shields.io/)\n[![ci workflow](https://github.com/pypiserver/pypiserver/actions/workflows/ci.yml/badge.svg)](https://github.com/pypiserver/pypiserver/actions/workflows/ci.yml)\n[![Generic badge](https://img.shields.io/badge/python-3.6%7C3.7%7C3.8+-blue.svg)](https://pypi.org/project/pypiserver/)\n[![Generic badge](https://img.shields.io/badge/license-MIT%7Czlib/libpng-blue.svg)](https://raw.githubusercontent.com/pypiserver/pypiserver/main/LICENSE.txt)\n\n| name | description |\n| :---------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Version | 2.3.2 |\n| Date: | 2024-11-24 |\n| Source | |\n| PyPI | |\n| Tests | |\n| Maintainers | [`@ankostis`](https://github.com/ankostis), [`@mplanchard`](https://github.com/mplanchard), [`@dee-me-tree-or-love`](https://github.com/dee-me-tree-or-love), [`@pawamoy`](https://github.com/pawamoy), **Someone new?** *We are open for new maintainers! [#397](https://github.com/pypiserver/pypiserver/issues/397)* |\n| License | zlib/libpng + MIT |\n| Community | |\n\n> [!TIP]\n> Reach out in [**Discussions**](https://github.com/pypiserver/pypiserver/discussions),\n> or chat with us on [**Zulip**](https://pypiserver.zulipchat.com)\n\n**pypiserver** is a minimal [PyPI](https://pypi.org/) compatible server for **pip** or **easy_install**.\nIt is based on [bottle](http://bottlepy.org/) and serves packages from regular directories.\nWheels, bdists, eggs and accompanying PGP-signatures can be uploaded\neither with **pip**, **setuptools**, **twine**, **pypi-uploader**, or simply copied\nwith **scp**.\n\n> [!Note]\n> The official software powering [PyPI](https://pypi.org/) is\n> [Warehouse](https://github.com/pypa/warehouse/). However,\n> [Warehouse](https://github.com/pypa/warehouse/)\n> is fairly specialized to be **pypi.org**'s own software, and should not\n> be used in other contexts. In particular, it does not officially support\n> being used as a custom package index by users wishing to serve their own\n> packages.\n\n**pypiserver** implements the same interfaces as [PyPI](https://pypi.org/), allowing\nstandard Python packaging tooling such as **pip** and **twine** to\ninteract with it as a package index just as they would with [PyPI](https://pypi.org/), while\nmaking it much easier to get a running index server.\n\n# pypiserver\n\nTable of Contents\n\n- [**pypiserver - minimal PyPI server for use with pip/easy_install**](#pypiserver---minimal-pypi-server-for-use-with-pipeasy_install)\n- [pypiserver](#pypiserver)\n - [Quickstart Installation and Usage](#quickstart-installation-and-usage)\n - [More details about pypi server run](#more-details-about-pypi-server-run)\n - [More details about pypi-server update](#more-details-about-pypi-server-update)\n - [Client-Side Configurations](#client-side-configurations)\n - [Configuring pip](#configuring-pip)\n - [Configuring easy_install](#configuring-easy_install)\n - [Uploading Packages Remotely](#uploading-packages-remotely)\n - [Apache Like Authentication (htpasswd)](#apache-like-authentication-htpasswd)\n - [Upload with setuptools](#upload-with-setuptools)\n - [Upload with twine](#upload-with-twine)\n - [Using the Docker Image](#using-the-docker-image)\n - [Alternative Installation Methods](#alternative-installation-methods)\n - [Installing the Very Latest Version](#installing-the-very-latest-version)\n - [Recipes](#recipes)\n - [Managing the Package Directory](#managing-the-package-directory)\n - [Serving Thousands of Packages](#serving-thousands-of-packages)\n - [Managing Automated Startup](#managing-automated-startup)\n - [Running As a systemd Service](#running-as-a-systemd-service)\n - [Launching through supervisor](#launching-through-supervisor)\n - [Running As a service with NSSM](#running-as-a-service-with-nssm)\n - [Using a Different WSGI Server](#using-a-different-wsgi-server)\n - [Apache](#apache)\n - [gunicorn](#gunicorn)\n - [paste](#paste)\n - [Behind a Reverse Proxy](#behind-a-reverse-proxy)\n - [Nginx](#nginx)\n - [Supporting HTTPS](#supporting-https)\n - [Traefik](#traefik)\n - [Utilizing the API](#utilizing-the-api)\n - [Using Ad-Hoc Authentication Providers](#using-ad-hoc-authentication-providers)\n - [Use with MicroPython](#use-with-micropython)\n - [Custom Health Check Endpoint](#custom-health-check-endpoint)\n - [Configure a custom health endpoint by CLI arguments](#configure-a-custom-health-endpoint-by-cli-arguments)\n - [Configure a custom health endpoint by script](#configure-a-custom-health-endpoint-by-script)\n - [Sources](#sources)\n - [Known Limitations](#known-limitations)\n - [Similar Projects](#similar-projects)\n - [Unmaintained or archived](#unmaintained-or-archived)\n - [Related Software](#related-software)\n- [Licensing](#licensing)\n\n## Quickstart Installation and Usage\n\n**pypiserver** works with Python 3.6+ and PyPy3.\n\nOlder Python versions may still work, but they are not tested.\n\nFor legacy Python versions, use **pypiserver-1.x** series. Note that these are\nnot officially supported, and will not receive bugfixes or new features.\n\n> [!TIP]\n>\n> The commands below work on a unix-like operating system with a posix shell.\n> The **'~'** character expands to user's home directory.\n\nIf you're using Windows, you'll have to use their \"Windows counterparts\".\nThe same is true for the rest of this documentation.\n\n1. Install **pypiserver** with this command\n\n ```shell\n pip install pypiserver # Or: pypiserver[passlib,cache]\n mkdir ~/packages # Copy packages into this directory.\n ```\n\n > [!TIP]\n > See also [Alternative Installation methods](#alternative-installation-methods)\n\n1. Copy some packages into your **~/packages** folder and then\n get your **pypiserver** up and running\n\n ```shell\n pypi-server run -p 8080 ~/packages & # Will listen to all IPs.\n ```\n\n1. From the client computer, type this\n\n ```shell\n # Download and install hosted packages.\n pip install --extra-index-url http://localhost:8080/simple/ ...\n\n # or\n pip install --extra-index-url http://localhost:8080 ...\n\n # Search hosted packages.\n pip search --index http://localhost:8080 ...\n\n # Note that pip search does not currently work with the /simple/ endpoint.\n ```\n\n > [!TIP]\n > See also [Client-side configurations](#client-side-configurations) for avoiding tedious typing.\n\n1. Enter **pypi-server -h** in the cmd-line to print a detailed usage message\n\n \n\n ```text\n usage: pypi-server [-h] [-v] [--log-file FILE] [--log-stream STREAM]\n [--log-frmt FORMAT] [--hash-algo HASH_ALGO]\n [--backend {auto,simple-dir,cached-dir}] [--version]\n {run,update} ...\n\n start PyPI compatible package server serving packages from PACKAGES_DIRECTORY. If PACKAGES_DIRECTORY is not given on the command line, it uses the default ~/packages. pypiserver scans this directory recursively for packages. It skips packages and directories starting with a dot. Multiple package directories may be specified.\n\n positional arguments:\n {run,update}\n run Run pypiserver, serving packages from\n PACKAGES_DIRECTORY\n update Handle updates of packages managed by pypiserver. By\n default, a pip command to update the packages is\n printed to stdout for introspection or pipelining. See\n the `-x` option for updating packages directly.\n\n optional arguments:\n -h, --help show this help message and exit\n -v, --verbose Enable verbose logging; repeat for more verbosity.\n --log-file FILE Write logging info into this FILE, as well as to\n stdout or stderr, if configured.\n --log-stream STREAM Log messages to the specified STREAM. Valid values are\n stdout, stderr, and none\n --log-frmt FORMAT The logging format-string. (see `logging.LogRecord`\n class from standard python library)\n --hash-algo HASH_ALGO\n Any `hashlib` available algorithm to use for\n generating fragments on package links. Can be disabled\n with one of (0, no, off, false).\n --backend {auto,simple-dir,cached-dir}\n A backend implementation. Keep the default 'auto' to\n automatically determine whether to activate caching or\n not\n --version show program's version number and exit\n\n Visit https://github.com/pypiserver/pypiserver for more information\n ```\n\n### More details about pypi server run\n\nEnter **pypi-server run -h** in the cmd-line to print a detailed usage\n\n\n\n```text\nusage: pypi-server run [-h] [-v] [--log-file FILE] [--log-stream STREAM]\n [--log-frmt FORMAT] [--hash-algo HASH_ALGO]\n [--backend {auto,simple-dir,cached-dir}] [--version]\n [-p PORT] [-i HOST] [-a AUTHENTICATE]\n [-P PASSWORD_FILE] [--disable-fallback]\n [--fallback-url FALLBACK_URL]\n [--health-endpoint HEALTH_ENDPOINT] [--server METHOD]\n [-o] [--welcome HTML_FILE] [--cache-control AGE]\n [--log-req-frmt FORMAT] [--log-res-frmt FORMAT]\n [--log-err-frmt FORMAT]\n [package_directory [package_directory ...]]\n\npositional arguments:\n package_directory The directory from which to serve packages.\n\noptional arguments:\n -h, --help show this help message and exit\n -v, --verbose Enable verbose logging; repeat for more verbosity.\n --log-file FILE Write logging info into this FILE, as well as to\n stdout or stderr, if configured.\n --log-stream STREAM Log messages to the specified STREAM. Valid values are\n stdout, stderr, and none\n --log-frmt FORMAT The logging format-string. (see `logging.LogRecord`\n class from standard python library)\n --hash-algo HASH_ALGO\n Any `hashlib` available algorithm to use for\n generating fragments on package links. Can be disabled\n with one of (0, no, off, false).\n --backend {auto,simple-dir,cached-dir}\n A backend implementation. Keep the default 'auto' to\n automatically determine whether to activate caching or\n not\n --version show program's version number and exit\n -p PORT, --port PORT Listen on port PORT (default: 8080)\n -i HOST, -H HOST, --interface HOST, --host HOST\n Listen on interface INTERFACE (default: 0.0.0.0)\n -a AUTHENTICATE, --authenticate AUTHENTICATE\n Comma-separated list of (case-insensitive) actions to\n authenticate (options: download, list, update;\n default: update).\n \n Any actions not specified are not authenticated, so\n to authenticate downloads and updates, but allow\n unauthenticated viewing of the package list, you would\n use:\n \n pypi-server -a 'download, update' -P\n ./my_passwords.htaccess\n \n To disable authentication, use:\n \n pypi-server -a . -P .\n \n See the `-P` option for configuring users and\n passwords.\n \n Note that when uploads are not protected, the\n `register` command is not necessary, but `~/.pypirc`\n still needs username and password fields, even if\n bogus.\n -P PASSWORD_FILE, --passwords PASSWORD_FILE\n Use an apache htpasswd file PASSWORD_FILE to set\n usernames and passwords for authentication.\n \n To allow unauthorized access, use:\n \n pypi-server -a . -P .\n \n --disable-fallback Disable the default redirect to PyPI for packages not\n found in the local index.\n --fallback-url FALLBACK_URL\n Redirect to FALLBACK_URL for packages not found in the\n local index.\n --health-endpoint HEALTH_ENDPOINT\n Configure a custom liveness endpoint. It always\n returns 200 Ok if the service is up. Otherwise, it\n means that the service is not responsive.\n --server METHOD Use METHOD to run the server. Valid values include\n paste, cherrypy, twisted, gunicorn, gevent, wsgiref,\n and auto. The default is to use \"auto\", which chooses\n one of paste, cherrypy, twisted, or wsgiref.\n -o, --overwrite Allow overwriting existing package files during\n upload.\n --welcome HTML_FILE Use the contents of HTML_FILE as a custom welcome\n message on the home page.\n --cache-control AGE Add \"Cache-Control: max-age=AGE\" header to package\n downloads. Pip 6+ requires this for caching.AGE is\n specified in seconds.\n --log-req-frmt FORMAT\n A format-string selecting Http-Request properties to\n log; set to '%s' to see them all.\n --log-res-frmt FORMAT\n A format-string selecting Http-Response properties to\n log; set to '%s' to see them all.\n --log-err-frmt FORMAT\n A format-string selecting Http-Error properties to\n log; set to '%s' to see them all.\n\n```\n\n### More details about pypi-server update\n\nMore details about **pypi-server update**\n\n```text\nusage: pypi-server update [-h] [-v] [--log-file FILE] [--log-stream STREAM]\n [--log-frmt FORMAT] [--hash-algo HASH_ALGO]\n [--backend {auto,simple-dir,cached-dir}] [--version]\n [-x] [-d DOWNLOAD_DIRECTORY] [-u]\n [--blacklist-file IGNORELIST_FILE]\n [package_directory [package_directory ...]]\n\npositional arguments:\n package_directory The directory from which to serve packages.\n\noptional arguments:\n -h, --help show this help message and exit\n -v, --verbose Enable verbose logging; repeat for more verbosity.\n --log-file FILE Write logging info into this FILE, as well as to\n stdout or stderr, if configured.\n --log-stream STREAM Log messages to the specified STREAM. Valid values are\n stdout, stderr, and none\n --log-frmt FORMAT The logging format-string. (see `logging.LogRecord`\n class from standard python library)\n --hash-algo HASH_ALGO\n Any `hashlib` available algorithm to use for\n generating fragments on package links. Can be disabled\n with one of (0, no, off, false).\n --backend {auto,simple-dir,cached-dir}\n A backend implementation. Keep the default 'auto' to\n automatically determine whether to activate caching or\n not\n --version show program's version number and exit\n -x, --execute Execute the pip commands rather than printing to\n stdout\n -d DOWNLOAD_DIRECTORY, --download-directory DOWNLOAD_DIRECTORY\n Specify a directory where packages updates will be\n downloaded. The default behavior is to use the\n directory which contains the package being updated.\n -u, --allow-unstable Allow updating to unstable versions (alpha, beta, rc,\n dev, etc.)\n --blacklist-file IGNORELIST_FILE, --ignorelist-file IGNORELIST_FILE\n Don't update packages listed in this file (one package\n name per line, without versions, '#' comments\n honored). This can be useful if you upload private\n packages into pypiserver, but also keep a mirror of\n public packages that you regularly update. Attempting\n to pull an update of a private package from `pypi.org`\n might pose a security risk - e.g. a malicious user\n might publish a higher version of the private package,\n containing arbitrary code.\n```\n\n## Client-Side Configurations\n\nAlways specifying the pypi url on the command line is a bit\ncumbersome. Since **pypiserver** redirects **pip/easy_install** to the\n**pypi.org** index if it doesn't have a requested package, it is a\ngood idea to configure them to always use your local pypi index.\n\n### Configuring pip\n\nFor **pip** command this can be done by setting the environment variable\n**[PIP_EXTRA_INDEX_URL](https://packaging.python.org/en/latest/guides/hosting-your-own-index/)** in your **.bashr/.profile/.zshrc**\n\n```shell\nexport PIP_EXTRA_INDEX_URL=http://localhost:8080/simple/\n```\n\nor by adding the following lines to **~/.pip/pip.conf**\n\n```shell\n[global]\nextra-index-url = http://localhost:8080/simple/\n```\n\n> [!NOTE]\n>\n> If you have installed **pypiserver** on a remote url without *https*\n> you will receive an \"untrusted\" warning from *pip*, urging you to append\n> the **--trusted-host** option. You can also include this option permanently\n> in your configuration-files or environment variables.\n\n### Configuring easy_install\n\nFor **easy_install** command you may set the following configuration in\n**~/.pydistutils.cfg**\n\n```shell\n[easy_install]\nindex_url = http://localhost:8080/simple/\n```\n\n### Uploading Packages Remotely\n\nInstead of copying packages directly to the server's folder (i.e. with **scp**),\nyou may use python tools for the task, e.g. **python setup.py upload**.\nIn that case, **pypiserver** is responsible for authenticating the upload-requests.\n\n> [!NOTE]\n>\n> We strongly advise to ***password-protect*** your uploads!\n\nIt is possible to disable authentication for uploads (e.g. in intranets).\nTo avoid lazy security decisions, read help for **-P** and **-a** options.\n\n#### Apache Like Authentication (htpasswd)\n\n1. First make sure you have the **passlib** module installed (note that\n **passlib>=1.6** is required), which is needed for parsing the Apache\n *htpasswd* file specified by the **-P**, **--passwords** option\n (see next steps)\n\n ```shell\n pip install passlib\n ```\n\n1. Create the Apache **htpasswd** file with at least one user/password pair\n with this command (you'll be prompted for a password)\n\n ```shell\n htpasswd -sc htpasswd.txt \n ```\n\n> [!TIP]\n>\n> Read this [SO](http://serverfault.com/questions/152950/how-to-create-and-edit-htaccess-and-htpasswd-locally-on-my-computer-and-then-u)\n> question for running `htpasswd` cmd under *Windows*\n> or if you have bogus passwords that you don't care because they are for\n> an internal service (which is still \"bad\", from a security perspective...)\n> you may use this [public service](http://www.htaccesstools.com/htpasswd-generator/)\n\n\n\n> [!TIP]\n>\n> When accessing pypiserver via the api, alternate authentication\n> methods are available via the **auther** config flag. Any callable\n> returning a boolean can be passed through to the pypiserver config in\n> order to provide custom authentication. For example, to configure\n> pypiserver to authenticate using the [python-pam](https://pypi.org/project/python-pam/)\n>\n> ```shell\n> import pam\n> pypiserver.default_config(auther=pam.authenticate)\n> ```\n\nPlease see [`Using Ad-hoc authentication providers`](#using-ad-hoc-authentication-providers) for more information.\n\n1. You need to restart the server with the **-P** option only once\n (but user/password pairs can later be added or updated on the fly)\n\n ```shell\n ./pypi-server run -p 8080 -P htpasswd.txt ~/packages &\n ```\n\n#### Upload with setuptools\n\n1. On client-side, edit or create a **~/.pypirc** file with a similar content:\n\n ```shell\n [distutils]\n index-servers =\n pypi\n local\n\n [pypi]\n username:\n password:\n\n [local]\n repository: http://localhost:8080\n username: \n password: \n ```\n\n1. Then from within the directory of the python-project you wish to upload,\n issue this command:\n\n ```shell\n python setup.py sdist upload -r local\n ```\n\n#### Upload with twine\n\nTo avoid storing you passwords on disk, in clear text, you may either:\n\n- use the **register** *setuptools*'s command with the **-r** option,\n like that\n\n ```shell\n python setup.py sdist register -r local upload -r local\n ```\n\n- use *twine* library, which\n breaks the procedure in two steps. In addition, it supports signing\n your files with PGP-Signatures and uploading the generated *.asc* files\n to **pypiserver**::\n\n ```shell\n twine upload -r local --sign -identity user_name ./foo-1.zip\n ```\n\n## Using the Docker Image\n\nStarting with version 1.2.5, official Docker images will be built for each\npush to `main`, each dev, alpha, or beta release, and each final release.\nThe most recent full release will always be available under the tag **latest**,\nand the current `main` branch will always be available under the tag\n**unstable**.\n\nYou can always check to see what tags are currently available at our\n[*Docker Repo*](https://hub.docker.com/r/pypiserver/pypiserver/tags/).\n\nTo run the most recent release of **pypiserver** with Docker, simply\n\n```shell\n docker run pypiserver/pypiserver:latest run\n```\n\nThis starts **pypiserver** serving packages from the **/data/packages**\ndirectory inside the container, listening on the container port 8080.\n\nThe container takes all the same arguments as the normal **pypi-server**\nexecutable, with the exception of the internal container port (**-p**),\nwhich will always be 8080.\n\nOf course, just running a container isn't that interesting. To map\nport 80 on the host to port 8080 on the container::\n\n```shell\n docker run -p 80:8080 pypiserver/pypiserver:latest run\n```\n\nYou can now access your **pypiserver** at **localhost:80** in a web browser.\n\nTo serve packages from a directory on the host, e.g. **~/packages**\n\n```shell\n docker run -p 80:8080 -v ~/packages:/data/packages pypiserver/pypiserver:latest run\n```\n\nTo authenticate against a local **.htpasswd** file::\n\n```shell\n docker run -p 80:8080 -v ~/.htpasswd:/data/.htpasswd pypiserver/pypiserver:latest run -P .htpasswd packages\n```\n\nYou can also specify **pypiserver** to run as a Docker service using a\ncomposefile. An example composefile is provided as\n[`docker-compose.yaml`](./docker-compose.yml)\n\n## Alternative Installation Methods\n\nWhen trying the methods below, first use the following command to check whether\nprevious versions of **pypiserver** already exist, and (optionally) uninstall them::\n\n```shell\n# VERSION-CHECK: Fails if not installed.\npypi-server --version\n\n# UNINSTALL: Invoke again until it fails.\npip uninstall pypiserver\n```\n\n### Installing the Very Latest Version\n\nIn case the latest version in *pypi* is a pre-release, you have to use\n*pip*'s *--pre* option. And to update an existing installation combine it\nwith `--ignore-installed`\n\n```shell\npip install pypiserver --pre -I\n```\n\nYou can even install the latest **pypiserver** directly from *github* with the\nfollowing command, assuming you have *git* installed on your **PATH**\n\n```shell\npip install git+git://github.com/pypiserver/pypiserver.git\n```\n\n## Recipes\n\n### Managing the Package Directory\n\nThe **pypi-server** command has the **update** command that searches for updates of\navailable packages. It scans the package directory for available\npackages and searches on pypi.org for updates. Without further\noptions **pypi-server update** will just print a list of commands which must\nbe run in order to get the latest version of each package. Output\nlooks like:\n\n```shell\n$ ./pypi-server update \nchecking 106 packages for newer version\n\n.........u.e...........e..u.............\n.....e..............................e...\n..........................\n\nno releases found on pypi for PyXML, Pymacs, mercurial, setuptools\n\n# update raven from 1.4.3 to 1.4.4\npip -q install --no-deps --extra-index-url https://pypi.org/simple/ -d /home/ralf/packages/mirror raven==1.4.4\n\n# update greenlet from 0.3.3 to 0.3.4\npip -q install --no-deps --extra-index-url https://pypi.org/simple/ -d /home/ralf/packages/mirror greenlet==0.3.4\n```\n\nIt first prints for each package a single character after checking the\navailable versions on pypi. A dot(.) means the package is up-to-date, **'u'**\nmeans the package can be updated and **'e'** means the list of releases on\npypi is empty. After that it shows a *pip* command line which can be used\nto update a one package. Either copy and paste that or run\n**pypi-server update -x** in order to really execute those commands. You need\nto have *pip* installed for that to work however.\n\nSpecifying an additional **-u** option will also allow alpha, beta and\nrelease candidates to be downloaded. Without this option these\nreleases won't be considered.\n\n### Serving Thousands of Packages\n\n> [!IMPORTANT]\n> By default, **pypiserver** scans the entire packages directory each time an\n> incoming HTTP request occurs. This isn't a problem for a small number of\n> packages, but causes noticeable slow-downs when serving thousands of packages.\n\nIf you run into this problem, significant speedups can be gained by enabling\npypiserver's directory caching functionality. The only requirement is to\ninstall the **watchdog** package, or it can be installed during **pypiserver**\ninstallation, by specifying the **cache** extras option::\n\n```shell\npip install pypiserver[cache]\n```\n\nAdditional speedups can be obtained by using your webserver's builtin\ncaching functionality. For example, if you are using `nginx` as a\nreverse-proxy as described below in `Behind a reverse proxy`, you can\neasily enable caching. For example, to allow nginx to cache up to\n10 gigabytes of data for up to 1 hour::\n\n```shell\nproxy_cache_path /data/nginx/cache\n levels=1:2\n keys_zone=pypiserver_cache:10m\n max_size=10g\n inactive=60m\n use_temp_path=off;\n\nserver {\n # ...\n location / {\n proxy_cache pypiserver_cache;\n proxy_pass http://localhost:8080;\n }\n}\n```\n\n> [!TIP]\n> Using webserver caching is especially helpful if you have high request\n> volume. Using nginx caching, a real-world pypiserver installation was\n> able to easily support over 1000 package downloads/min at peak load.\n\n### Managing Automated Startup\n\nThere are a variety of options for handling the automated starting of\npypiserver upon system startup. Two of the most common are *systemd* and\n*supervisor* for linux systems. For windows creating services with scripts isn't\nan easy task without a third party tool such as *NSSM*.\n\n#### Running As a systemd Service\n\n**systemd** is installed by default on most modern Linux systems and as such,\nit is an excellent option for managing the pypiserver process. An example\nconfig file for **systemd** can be seen below\n\n```shell\n[Unit]\nDescription=A minimal PyPI server for use with pip/easy_install.\nAfter=network.target\n\n[Service]\nType=simple\n# systemd requires absolute path here too.\nPIDFile=/var/run/pypiserver.pid\nUser=www-data\nGroup=www-data\n\nExecStart=/usr/local/bin/pypi-server run -p 8080 -a update,download --log-file /var/log/pypiserver.log -P /etc/nginx/.htpasswd /var/www/pypi\nExecStop=/bin/kill -TERM $MAINPID\nExecReload=/bin/kill -HUP $MAINPID\nRestart=always\n\nWorkingDirectory=/var/www/pypi\n\nTimeoutStartSec=3\nRestartSec=5\n\n[Install]\nWantedBy=multi-user.target\n```\n\nAdjusting the paths and adding this file as **pypiserver.service** into your\n**systemd/system** directory will allow management of the pypiserver process with\n**systemctl**, e.g. **systemctl start pypiserver**.\n\nMore useful information about *systemd* can be found at\n\n\n#### Launching through supervisor\n\n[supervisor](http://supervisord.org/) has the benefit of being a pure python\npackage and as such, it provides excellent cross-platform support for process\nmanagement. An example configuration file for **supervisor** is given below\n\n```shell\n[program:pypi]\ncommand=/home/pypi/pypi-venv/bin/pypi-server run -p 7001 -P /home/pypi/.htpasswd /home/pypi/packages\ndirectory=/home/pypi\nuser=pypi\nautostart=true\nautorestart=true\nstderr_logfile=/var/log/pypiserver.err.log\nstdout_logfile=/var/log/pypiserver.out.log\n```\n\nFrom there, the process can be managed via **supervisord** using **supervisorctl**.\n\n#### Running As a service with NSSM\n\nFor Windows download [NSSM](https://nssm.cc/) from unzip to a\ndesired location such as Program Files. Decide whether you are going\nto use `win32` or `win64`, and add that `exe` to environment `PATH`.\n\nCreate a start_pypiserver.bat\n\n```shell\npypi-server run -p 8080 C:\\Path\\To\\Packages &\n```\n\n> [!TIP]\n> Test the batch file by running it first before creating the service.\n> Make sure you can access the server remotely, and install packages. If you can,\n> proceed, if not troubleshoot until you can. This will ensure you know the server\n> works, before adding NSSM into the mix.\n\nFrom the command prompt\n\n```shell\nnssm install pypiserver\n```\n\nThis command will launch a NSSM gui application\n\n```shell\nPath: C:\\Path\\To\\start_pypiserver.bat\nStartup directory: Auto generates when selecting path\nService name: pypiserver\n```\n\nThere are more tabs, but that is the basic setup. If the service needs to be running with a certain\nlogin credentials, make sure you enter those credentials in the logon tab.\n\nStart the service\n\n```shell\nnssm start pypiserver\n```\n\n> [!TIP]\n> Other useful commands\n>\n> ```shell\n> nssm --help\n> nssm stop \n> nssm restart \n> nssm status \n> ```\n>\n> For detailed information please visit \n\n### Using a Different WSGI Server\n\n- The **bottle** web-server which supports many WSGI-servers, among others,\n **paste**, **cherrypy**, **twisted** and **wsgiref** (part of Python); you select\n them using the **--server** flag.\n\n- You may view all supported WSGI servers using the following interactive code\n\n ```python\n >>> from pypiserver import bottle\n >>> list(bottle.server_names.keys())\n ['cgi', 'gunicorn', 'cherrypy', 'eventlet', 'tornado', 'geventSocketIO',\n 'rocket', 'diesel', 'twisted', 'wsgiref', 'fapws3', 'bjoern', 'gevent',\n 'meinheld', 'auto', 'aiohttp', 'flup', 'gae', 'paste', 'waitress']\n ```\n\n- If none of the above servers matches your needs, invoke just the\n **pypiserver:app()** method which returns the internal WSGI-app WITHOUT\n starting-up a server - you may then send it to any WSGI server you like.\n Read also the [Utilizing the API](#utilizing-the-api) section.\n\n- Some examples are given below - you may find more details in [bottle\n site](http://bottlepy.org/docs/dev/deployment.html#switching-the-server-backend%3E).\n\n#### Apache\n\nTo use your *Apache2* with **pypiserver**, prefer to utilize **mod_wsgi** as\nexplained in [bottle's documentation](http://bottlepy.org/docs/dev/deployment.html#apache-mod-wsgi%3E).\n\n> [!NOTE]\n> If you choose instead to go with **mod_proxy**, mind that you may bump into problems\n> with the prefix-path (see [#155](https://github.com/pypiserver/pypiserver/issues/155%3E)).\n\n1. Adapt and place the following *Apache* configuration either into top-level scope,\n or inside some **``** (contributed by Thomas Waldmann):\n\n ```shell\n WSGIScriptAlias / /yoursite/wsgi/pypiserver-wsgi.py\n WSGIDaemonProcess pypisrv user=pypisrv group=pypisrv umask=0007 \\\n processes=1 threads=5 maximum-requests=500 \\\n display-name=wsgi-pypisrv inactivity-timeout=300\n WSGIProcessGroup pypisrv\n WSGIPassAuthorization On # Required for authentication (https://github.com/pypiserver/pypiserver/issues/288)\n\n \n Require all granted\n \n ```\n\n or if using older **Apache < 2.4**, substitute the last part with this::\n\n ```shell\n \n Order deny,allow\n Allow from all\n \n ```\n\n1. Then create the **/yoursite/cfg/pypiserver.wsgi** file and make sure that\n the **user** and **group** of the **WSGIDaemonProcess** directive\n (**pypisrv:pypisrv** in the example) have the read permission on it\n\n ```python\n\n import pypiserver\n\n conf = pypiserver.default_config(\n root = \"/yoursite/packages\",\n password_file = \"/yoursite/htpasswd\", )\n application = pypiserver.app(**conf)\n\n ```\n\n > [!TIP]\n > If you have installed **pypiserver** in a virtualenv, follow **mod_wsgi**'s\n > [instructions](http://modwsgi.readthedocs.io/en/develop/user-guides/virtual-environments.html)\n > and prepend the python code above with the following\n >\n > ```python\n > import site\n >\n > site.addsitedir('/yoursite/venv/lib/pythonX.X/site-packages')\n > ```\n\n\n\n> [!NOTE]\n> For security reasons, notice that the **Directory** directive grants access\n> to a directory holding the **wsgi** start-up script, alone; nothing else.\n\n\n\n> [!NOTE]\n> To enable HTTPS support on Apache, configure the directive that contains the\n> WSGI configuration to use SSL.\n\n#### gunicorn\n\nThe following command uses **gunicorn** to start **pypiserver**\n\n```shell\ngunicorn -w4 'pypiserver:app(root=\"/home/ralf/packages\")'\n```\n\nor when using multiple roots\n\n```shell\ngunicorn -w4 'pypiserver:app(root=[\"/home/ralf/packages\", \"/home/ralf/experimental\"])'\n```\n\n#### paste\n\n[paste](http://pythonpaste.org) allows to run multiple WSGI applications\nunder different URL paths. Therefore, it is possible to serve different set\nof packages on different paths.\n\nThe following example **paste.ini** could be used to serve stable and\nunstable packages on different paths\n\n```shell\n [composite:main]\n use = egg:Paste#urlmap\n /unstable/ = unstable\n / = stable\n\n [app:stable]\n use = egg:pypiserver#main\n root = ~/stable-packages\n\n [app:unstable]\n use = egg:pypiserver#main\n root = ~/stable-packages\n ~/unstable-packages\n\n [server:main]\n use = egg:gunicorn#main\n host = 0.0.0.0\n port = 9000\n workers = 5\n accesslog = -\n```\n\n> [!NOTE]\n> You need to install some more dependencies for this to work, like::\n>\n> ```shell\n> pip install paste pastedeploy gunicorn pypiserver\n> ```\n>\n> The server can then start with\n>\n> ```shell\n> gunicorn_paster paste.ini\n> ```\n\n### Behind a Reverse Proxy\n\nYou can run **pypiserver** behind a reverse proxy as well.\n\n#### Nginx\n\nExtend your nginx configuration\n\n```shell\nupstream pypi {\n server pypiserver.example.com:12345 fail_timeout=0;\n}\n\nserver {\n server_name myproxy.example.com;\n\n location / {\n proxy_set_header Host $host:$server_port;\n proxy_set_header X-Forwarded-Proto $scheme;\n proxy_set_header X-Real-IP $remote_addr;\n proxy_pass http://pypi;\n }\n}\n```\n\nAs of pypiserver 1.3, you may also use the `X-Forwarded-Host` header in your\nreverse proxy config to enable changing the base URL. For example if you\nwant to host pypiserver under a particular path on your server\n\n```shell\nupstream pypi {\n server localhost:8000;\n}\n\nserver {\n location /pypi/ {\n proxy_set_header X-Forwarded-Host $host:$server_port/pypi;\n proxy_set_header X-Forwarded-Proto $scheme;\n proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;\n proxy_set_header X-Real-IP $remote_addr;\n proxy_pass http://pypi;\n }\n}\n```\n\n#### Supporting HTTPS\n\nUsing a reverse proxy is the preferred way of getting pypiserver behind\nHTTPS. For example, to put pypiserver behind HTTPS on port 443, with\nautomatic HTTP redirection, using `nginx`\n\n```shell\nupstream pypi {\n server localhost:8000;\n}\n\nserver {\n listen 80 default_server;\n server_name _;\n return 301 https://$host$request_uri;\n}\n\nserver {\n listen 443 ssl;\n server_name pypiserver.example.com;\n\n ssl_certificate /etc/star.example.com.crt;\n ssl_certificate_key /etc/star.example.com.key;\n ssl_protocols TLSv1 TLSv1.1 TLSv1.2;\n ssl_ciphers HIGH:!aNULL:!MD5;\n\n location / {\n proxy_set_header Host $host:$server_port;\n proxy_set_header X-Forwarded-Proto $scheme;\n proxy_set_header X-Real-IP $remote_addr;\n proxy_pass http://pypi;\n }\n}\n```\n\n> [!TIP]\n> Please see [nginx's HTTPS docs for more details](http://nginx.org/en/docs/http/configuring_https_servers.html).\n>\n> Getting and keeping your certificates up-to-date can be simplified using,\n> for example, using [certbot and letsencrypt](https://www.digitalocean.com/community/tutorials/how-to-secure-nginx-with-let-s-encrypt-on-ubuntu-18-04%3E).\n\n#### Traefik\n\nIt is also possible to use [Traefik](https://docs.traefik.io/) to put pypiserver\nbehind HTTPS on port 443, with automatic HTTP redirection using Docker Compose.\nPlease see the provided\n[docker-compose.yml](./docker-compose.yml)\nexample for more information.\n\n### Utilizing the API\n\nIn order to enable ad-hoc authentication-providers or to use WSGI-servers\nnot supported by *bottle* out-of-the-box, you needed to launch **pypiserver**\nvia its API.\n\n- The main entry-point for configuring **pypiserver** is the\n [pypiserver:app()](./pypiserver/__init__.py#L116)\n function. This function returns the internal WSGI-app that you my then\n send to any WSGI-server you like.\n\n- To get all **pypiserver:app()** keywords and their explanations, read the\n function [pypiserver:default_config()](./pypiserver/__init__.py#L35)\n\n- Finally, to fire-up a WSGI-server with the configured app, invoke\n the **bottle:run(app, host, port, server)** function.\n Note that **pypiserver** ships with its own copy of *bottle*; to use it,\n import it like that: **from pypiserver import bottle**\n\n#### Using Ad-Hoc Authentication Providers\n\nThe **auther** keyword of **pypiserver:app()** function maybe set only using\nthe API. This can be any callable that returns a boolean when passed\nthe *username* and the *password* for a given request.\n\nFor example, to authenticate users based on the **/etc/passwd** file under Unix,\nyou may delegate such decisions to the [python-pam](https://pypi.org/project/python-pam/) library by following\nthese steps:\n\n1. Ensure **python-pam** module is installed\n\n ```shell\n pip install python-pam\n ```\n\n1. Create a python-script along these lines\n\n ```shell\n $ cat > pypiserver-start.py\n import pypiserver\n from pypiserver import bottle\n import pam\n app = pypiserver.app(root='./packages', auther=pam.authenticate)\n bottle.run(app=app, host='0.0.0.0', port=80, server='auto')\n\n [Ctrl+ D]\n ```\n\n1. Invoke the python-script to start-up **pypiserver**\n\n ```shell\n python pypiserver-start.py\n ```\n\n> [!NOTE]\n> The [python-pam](https://pypi.org/project/python-pam/) module, requires *read* access to **/etc/shadow** file;\n> you may add the user under which **pypiserver** runs into the *shadow*\n> group, with a command like this: **sudo usermod -a -G shadow pypy-user**.\n\n### Use with MicroPython\n\nThe MicroPython interpreter for embedded devices can install packages with the\nmodule **upip.py**. The module uses a specialized json-endpoint to retrieve\npackage information. This endpoint is supported by **pypiserver**.\n\nIt can be tested with the UNIX port of **micropython**\n\n```shell\ncd micropython\nports/unix/micropython -m tools.upip install -i http://my-server:8080 -p /tmp/mymodules micropython-foobar\n```\n\nInstalling packages from the REPL of an embedded device works in this way:\n\n```python\nimport network\nimport upip\n\nsta_if = network.WLAN(network.STA_IF)\nsta_if.active(True)\nsta_if.connect('', '')\nupip.index_urls = [\"http://my-server:8080\"]\nupip.install(\"micropython-foobar\")\n```\n\nFurther information on micropython-packaging can be found here: \n\n### Custom Health Check Endpoint\n\n**pypiserver** provides a default health endpoint at **/health**. It always returns\n**200 Ok** if the service is up. Otherwise, it means that the service is not responsive.\n\nIn addition, **pypiserver** allows users to customize the health endpoint.\nAlphanumeric characters, hyphens, forward slashes and underscores are allowed\nand the endpoint should not overlap with any existing routes.\nValid examples: **/healthz**, **/health/live-1**, **/api_health**, **/action/health**\n\n#### Configure a custom health endpoint by CLI arguments\n\nRun pypiserver with **--health-endpoint** argument:\n\n```shell\npypi-server run --health-endpoint /action/health\n```\n\n#### Configure a custom health endpoint by script\n\n```python\nimport pypiserver\nfrom pypiserver import bottle\napp = pypiserver.app(root=\"./packages\", health_endpoint=\"/action/health\")\nbottle.run(app=app, host=\"0.0.0.0\", port=8080, server=\"auto\")\n```\n\nTry **curl **\n\n## Sources\n\nTo create a copy of the repository, use\n\n```shell\ngit clone https://github.com/pypiserver/pypiserver.git\ncd pypiserver\n```\n\nTo receive any later changes, in the above folder use:\n\n```shell\ngit pull\n```\n\n## Known Limitations\n\n> [!IMPORTANT]\n> **pypiserver** does not implement the full API as seen on [PyPI](https://pypi.org/).\n> It implements just enough to make **easy_install**, **pip install**, and\n> **search** work.\n\nThe following limitations are known:\n\n- Command **pypi -U** that compares uploaded packages with *pypi* to see if\n they are outdated, does not respect a http-proxy environment variable\n (see [#19](https://github.com/pypiserver/pypiserver/issues/19).\n- It accepts documentation uploads but does not save them to\n disk (see [#47](https://github.com/pypiserver/pypiserver/issues/47) for a\n discussion)\n- It does not handle misspelled packages as *pypi-repo* does,\n therefore it is suggested to use it with **--extra-index-url** instead\n of **--index-url** (see [#38](https://github.com/pypiserver/pypiserver/issues/38)).\n\nPlease use Github's [bugtracker](https://github.com/pypiserver/pypiserver/issues)\nfor other bugs you find.\n\n## Similar Projects\n\nThere are lots of other projects, which allow you to run your own\nPyPI server. If **pypiserver** doesn't work for you, the following are\namong the most popular alternatives:\n\n- [devpi-server](https://pypi.org/project/devpi/):\n a reliable fast pypi.org caching server, part of\n the comprehensive [github-style pypi index server and packaging meta tool](https://pypi.org/project/devpi/).\n (version: 2.1.4, access date: 8/3/2015)\n\n- Check this SO question: [How to roll my own pypi](http://stackoverflow.com/questions/1235331/how-to-roll-my-own-pypi)\n\n### Unmaintained or archived\n\nThese projects were once alternatives to pypiserver but are now either unmaintained or archived.\n\n- [pip2pi](https://github.com/wolever/pip2pi)\n a simple cmd-line tool that builds a PyPI-compatible local folder from pip requirements\n\n- [flask-pypi-proxy](http://flask-pypi-proxy.readthedocs.org/)\n A proxy for PyPI that also enables uploading custom packages.\n\n## Related Software\n\nThough not direct alternatives for **pypiserver**'s use as an index\nserver, the following is a list of related software projects that you\nmay want to familiarize with:\n\n- [pypi-uploader](https://pypi.org/project/pypi-uploader/):\n A command-line utility to upload packages to your **pypiserver** from pypi without\n having to store them locally first.\n\n- [twine](https://pypi.org/project/twine/):\n A command-line utility for interacting with PyPI or **pypiserver**.\n\n- [warehouse](https://github.com/pypa/warehouse/):\n the software that powers [PyPI](https://pypi.org/) itself. It is not generally intended to\n be run by end-users.\n\n# Licensing\n\n**pypiserver** contains a copy of [bottle](http://bottlepy.org/) which is\navailable under the MIT license, and the remaining part is distributed under\nthe zlib/libpng license. See the **LICENSE.txt** file.\n","description_content_type":"text/markdown","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"https://github.com/pypiserver/pypiserver","keywords":null,"license":null,"license_expression":null,"license_files":null,"maintainer":"Kostis Anagnostopoulos Matthew Planchard ","maintainer_email":"ankostis@gmail.com","name":"pypiserver","package_url":"https://pypi.org/project/pypiserver/","platform":"any","project_url":"https://pypi.org/project/pypiserver/","project_urls":{"Homepage":"https://github.com/pypiserver/pypiserver"},"provides_extra":["passlib","cache"],"release_url":"https://pypi.org/project/pypiserver/2.3.2/","requires_dist":["pip>=7","packaging>=23.2","importlib_resources; python_version > \"3.8\" and python_version < \"3.12\"","passlib>=1.6; extra == \"passlib\"","watchdog; extra == \"cache\""],"requires_python":">=3.6","summary":"A minimal PyPI server for use with pip/easy_install.","version":"2.3.2","yanked":false,"yanked_reason":null}

Dependency	Optional
importlib_resources	false
packaging	false
pip	false
passlib	true
watchdog	true

Package search

pypiserver

project_urls

Dependencies

All package metadata

Releases