Package: dumb-pypi
dumb-pypidumb-pypiis a simple read-only PyPI index server generator, backed entirely
by static files. It is ideal for internal use by organizations that have a
bunch of their own packages which they'd like to make available.You can viewan example generated repo.A rant about static files (and why you should use dumb-pypi)The main difference between dumb-pypi and other PyPI implementations is that
dumb-pypi hasno server component. It's just a script that, given a list of
Python package names, generates a bunch of static files which you can serve
from any webserver, or even directly from S3.There's something magical about being able to serve a package repository
entirely from a tree of static files. It's incredibly easy to make it fast and
highly-available when you don't need to worry about running a bunch of
application servers (which are serving a bunch of read-only queries that could
have just been pre-generated).Linux distributions have been doing this right for decades. Debian has a system
of hundreds of mirrors, and the entire thing is powered entirely by some fancyrsynccommands.For the maintainer of a PyPI repositry,dumb-pypihas some nice properties:File serving is extremely fast.nginx can serve your static files faster
than you'd ever need. In practice, there are almost no limits on the number
of packages or number of versions per package.It's very simple.There's no complicated WSGI app to deploy, no
databases, and no caches. You just need to run the script whenever you have
new packages, and your index server is ready in seconds.For more about why this design was chosen, see the detailedRATIONALE.mdin this repo.UsageTo use dumb-pypi, you need two things:A script which generates the index. (That's this project!)A generic webserver to serve the generated index.This part is up to you. For example, you might sync the built index into an
S3 bucket, and serve it directly from S3. You might run nginx from the built
index locally.My recommended high-availability (but still quite simple) deployment is:Store all of the packages in S3.Have a cronjob (or equivalent) which rebuilds the index based on the packages
in S3. This is incredibly fast—it would not be unreasonable to do it every
sixty seconds. After building the index, sync it into a separate S3 bucket.Have a webserver (or set of webservers behind a load balancer) running nginx
(with the config provided below), with the source being that second S3
bucket.Generating static filesFirst, installdumb-pypisomewhere (e.g. into a virtualenv).By design, dumb-pypi doesnotrequire you to have the packages available when
building the index. You only need a list of filenames, one per line. For
example:dumb-init-1.1.2.tar.gz
dumb_init-1.2.0-py2.py3-none-manylinux1_x86_64.whl
ocflib-2016.10.31.0.40-py2.py3-none-any.whl
pre_commit-0.9.2.tar.gzYou should also know a URL to access these packages (if you serve them from the
same host as the index, it can be a relative URL). For example, it might behttps://my-pypi-packages.s3.amazonaws.com/or../../pool/.You can then invoke the script:$dumb-pypi\--package-listmy-packages\--packages-urlhttps://my-pypi-packages.s3.amazonaws.com/\--output-dirmy-built-indexThe built index will be inmy-built-index. It's now up to you to figure out
how to serve that with a webserver (nginx is a good option — details below!).Additional options for packagesYou can extend the capabilities of your registry using the extended JSON input
syntax when providing your package list to dumb-pypi. Instead of using the
format listed above of one filename per line, format your file with one JSON
object per line, like this:{"filename":"dumb-init-1.1.2.tar.gz","hash":"sha256=<hash>","requires_python":">=3.6","uploaded_by":"ckuehl","upload_timestamp":1512539924,"yanked_reason":null,"core_metadata":"sha256=<hash>"}KeyRequired?DescriptionfilenameYesName of the filehashNoHash of the file in the format<hashalgo>=<hashvalue>requires_pythonNoPython requirement string for the package (PEP345)core_metadataNoEither string"true"or a string in the format<hashalgo>=<hashvalue>to indicate metadata is available for this file by appending.metadatato the file URL (PEP658,PEP714)uploaded_byNoFreeform text to indicate an uploader of the package; only shown on web UIupload_timestampNoUNIX timestamp to indicate upload time of the packageyanked_reasonNoFreeform text to indicate the package is yanked for the given reason (PEP592)requires_distNo(Deprecated)Array of requires_dist dependencies (PEP345), used only in the JSON API; consider usingcore_metadatainsteadThefilenamekey is required. All other keys are optional and will be used to
provide additional information in your generated repository. This extended
information can be useful to determine, for example, who uploaded a package.
(Most of this information is useful in the web UI by humans, not by pip.)Where should you get information about the hash, uploader, etc? That's up to
you—dumb-pypi isn't in the business of storing or calculating this data. If
you're using S3, one easy option is to store it at upload time asS3
metadata.Partial rebuild supportIf you want to avoid rebuilding your entire registry constantly, you can pass
the--previous-package-list(or--previous-package-list-json) argument to
dumb-pypi, pointing to the list you used the last time you called dumb-pypi.
Only the files relating to changed packages will be rebuilt, saving you time
and unnecessary I/O.The previous package list json is available in the output aspackages.json.Recommended nginx configYou can serve the packages from any static webserver (including directly from
S3), but for compatibility with old versions of pip, it's necessary to do a
tiny bit of URL rewriting (seeRATIONALE.mdfor full details
about the behavior of various pip versions).In particular, if you want to support old pip versions, you need to apply this
logic to package names (taken fromPEP 503):defnormalize(name):returnre.sub(r'[-_.]+','-',name).lower()Here is an example nginx config which supports all versions of pip and
easy_install:server{location/{root/path/to/index;set_by_lua$canonical_uri"returnstring.gsub(string.lower(ngx.var.uri),'[-_.]+','-')";try_files$uri$uri/index.html$canonical_uri$canonical_uri/index.html=404;}}If you don't care about easy_install or versions of pip prior to 8.1.2, you can
omit thecanonical_urihack.Using your deployed index server with pipWhen running pip, pass-i https://my-pypi-server/simpleor set the
environment variablePIP_INDEX_URL=https://my-pypi-server/simple.Known incompatibilities with public PyPIWe try to maintain compatibility with the standard PyPI interface, but there
are some incompatibilities currently which are hard to fix due to dumb-pypi's
design:Whileboth JSON API endpointsare supported, many keys in the
JSON API are not present since they require inspecting packages which
dumb-pypi can't do. Some of these, likerequires_pythonandrequires_dist, can be passed in as JSON.Theper-version JSON API endpointonly includes data about
the current requested version and notallversions, unlike public PyPI. In
other words, if you access/pypi/<package>/1.0.0/json, you will only see
the1.0.0release under thereleaseskey and not every release ever made.
The regular non-versioned API route (/pypi/<package>/json) will have all
releases.ContributingThanks for contributing! To get started, runmake venvand then. venv/bin/activateto source the virtualenv. You should now have adumb-pypicommand on your path using your checked-out version of the code.To run the tests, callmake test. To run an individual test, you can dopytest -k name_of_test tests(with the virtualenv activated).