pypihub

package module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 21, 2016 License: MIT Imports: 12 Imported by: 0

README

PyPIHub

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.

Installing

go get github.com/brettlangdon/pypihub

Running

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
Example
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

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
Using an env file
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

Endpoints

  • / - 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/
  • /<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
  • /<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
  • /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 by pip when using --extra-index-url
    • See /simple example above for usage

Usage with pip

Simple index
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
requirements.txt
--find-links http://localhost:8287/
<project>

pip install -r requirements.txt

GitHub repo requirements

Project structure

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).

Releases

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.

Version names

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.

Assets

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.

Differences with other projects

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.

Security

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.

Documentation

Index

Constants

View Source 
const VERSION = "0.1.0"

Variables

This section is empty.

Functions

This section is empty.

Types

type Asset 

type Asset struct {
	ID     int
	Name   string
	Owner  string
	Repo   string
	Ref    string
	Format string
}

func (Asset) Download 

func (a Asset) Download(c *Client) (io.ReadCloser, error)

func (Asset) String 

func (a Asset) String() string

func (Asset) URL 

func (a Asset) URL() string

type Client 

type Client struct {
	// contains filtered or unexported fields
}

func NewClient 

func NewClient(cfg Config) *Client

func (*Client) DownloadArchive 

func (c *Client) DownloadArchive(a Asset) (io.ReadCloser, error)

func (*Client) DownloadAsset 

func (c *Client) DownloadAsset(a Asset) (io.ReadCloser, error)

func (*Client) GetAllAssets 

func (c *Client) GetAllAssets() ([]Asset, error)

func (*Client) GetRepoAssets 

func (c *Client) GetRepoAssets(r string) ([]Asset, error)

type Config 

type Config struct {
	Username    string   `arg:"-u,--username,env:PYPIHUB_USERNAME,required,help:Username of GitHub user to login as (env: PYPIHUB_USERNAME)"`
	AccessToken string   `` /* 145-byte string literal not displayed */
	RepoNames   []string `arg:"positional,help:list of '<username>/<repo>' repos to proxy for (env: PYPIHUB_REPOS)"`
	Bind        string   `arg:"-b,--bind,env:PYPIHUB_BIND,help:[<address>]:<port> to bind the server to (default: ':8287') (env: PYPIHUB_BIND)"`
}

func ParseConfig 

func ParseConfig() Config

func (Config) Version 

func (c Config) Version() string

type Router 

type Router struct {
	// contains filtered or unexported fields
}

func NewRouter 

func NewRouter(config Config) *Router

func (*Router) Handler 

func (r *Router) Handler() http.Handler

func (*Router) Start 

func (r *Router) Start() error

Source Files

View all Source files

Directories

Path Synopsis
cmd
pypihub

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.