PyPI server for serving Python packages out of GitHub.
This project is useful if you have private Python packages in GitHub that you want to install via pip
.
Note: You can use -e git+ssh://git@github.com/<owner>/<repo>@<tag>
with pip
to install private packages using git.
However, if you needed to allow someone without ssh access to GitHub the ability to install your package, or make private packages installable from a location that does not have ssh access to GitHub (e.g. docker container) then this server will make that easier for you.
go get github.com/brettlangdon/pypihub
pypihub -h
usage: pypihub --username USERNAME --access-token ACCESS-TOKEN [--bind BIND] [REPONAMES [REPONAMES ...]]
positional arguments:
reponames list of '<username>/<repo>' repos to proxy for (env: PYPIHUB_REPOS)
options:
--username USERNAME, -u USERNAME
Username of GitHub user to login as (env: PYPIHUB_USERNAME)
--access-token ACCESS-TOKEN, -a ACCESS-TOKEN
GitHub personal access token to use for authenticating (env: PYPIHUB_ACCESS_TOKEN)
--bind BIND, -b BIND [<address>]:<port> to bind the server to (default: ':8287') (env: PYPIHUB_BIND) [default: :8287]
--help, -h display this help and exit
pypihub -u "<username>" -a "<github-access-token>" "brettlangdon/flask-env" "brettlangdon/flask-defer" [... <owner>/<repo>]
export PYPIHUB_USERNAME="<username>"
export PYPIHUB_ACCESS_TOKEN="<github-access-token>""
export PYPIHUB_REPOS="brettlangdon/flask-env brettlangdon/flask-defer [... <owner>/<repo>]"
pypihub
docker run --rm -it -p "8287:8287" -e PYPIHUB_USERNAME="<username>" -e PYPIHUB_ACCESS_TOKEN="<github-acess-token>" -e PYPIHUB_REPOS="<owner>/<repo> ..." brettlangdon/pypihub:latest
PYPIHUB_USERNAME=<username>
PYPIHUB_ACCESS_TOKEN=<github-access-token>
PYPIHUB_REPOS=<owner>/<repo> ...
docker run --rm -it -p "8287:8287" --env-file ./.env brettlangdon/pypihub:latest
/
- Page containing all links for all projects/assets- This endpoint can be used with
--find-links
to make all projects accessible - e.g.
pip install --find-links http://localhost:8287/
- This endpoint can be used with
/<owner>
- Page containing all links for a given GitHub repo owner- This endpoint can be used with
--find-links
to make all projects for a given GitHub owner accessible - e.g.
pip install --find-links http://localhost:8287/brettlangdon
- This endpoint can be used with
/<owner>/<repo>
- Page containing all links for a specific GitHub repo- This endpoint can be used with
--find-links
to make all releases for a specific GitHub repo accessible - e.g.
pip install --find-links http://localhost:8287/brettlangdon/flask-env
- This endpoint can be used with
/simple
- PyPI simple index page- This page lists all of the project names available
- This endpoint can be used with
--index-url
or--extra-index-url
- e.g.
pip install --extra-index-url http://localhost:8287/simple
/simple/<repo>
- PyPI simple index project links page- This page contains the links for the given project name
- This endpoint can be used with
--find-links
, but is typically used bypip
when using--extra-index-url
- See
/simple
example above for usage
pip install --index-url http://localhost:8287/simple <project>
pip install --extra-index-url http://localhost:8287/simple <project>
pip install --find-links http://localhost:8287/ <project>
pip install --find-links http://localhost:8287/<owner> project
pip install --find-links http://localhost:8287/<owner>/<project> project
--find-links http://localhost:8287/
<project>
pip install -r requirements.txt
PyPIHub will not validate the source files of your package, however, you should structure the package as though you would publish them to PyPI.
This means that your package should contain a setup.py
file and be installable (you can use python setup.py install
or python setup.py develop
to test).
PyPIHub expects that you use tags in your repo to denote releases.
If you use GitHub releases for your repo, then only those releases will be used by PyPIHub.
However, if you do not use GitHub releases, then all git tags will be used as versions.
It is recommended (but not required) that you use Semantic Versioning of your projects.
Note: PyPIHub will automatically strip any leading v
from your version/tag name. This will turn v1.0.0
into 1.0.0
, which is more pip
friendly.
PyPIHub will always try to make a .tar.gz
source asset available for installing from either your release or tag.
However, it is recommended that create a release and build/upload the assets for your package.
See Creating releases for more information.
To build assets, you can use python setup.py sdist bdist_wheel
which will create a .tar.gz
and a .whl
file into a ./dist
directory.
Both of these files can and should be attached to the release.
PyPIHub differs from other projects, like devpi in that it doesn't try to be a fully functioning replica of PyPI.
PyPIHub does not support creating users, uploading packages, or even mirroring PyPI. Is meant purely as a pip
compatible proxy for packages stored in GitHub repos.
PyPIHub does not offer any security/authentication methods. This means that anyone who has access to make HTTP requests to the server will be able to access all source files for the proxied projects.
This implementation is by design. PyPIHub is meant to act as an unauthenticated proxy for private python packages for local development/testing.