Skip to main content

Private Python Package Index

Project description

Getting Started

Pyshop is a private repository for python packages.

The aim is to split private projects in distinct private packages and keep a clean and working, by declaring all dependencies, exactly as public packages on PyPI.

Pyshop also proxies and caches packages from PyPI safely using SSL and checking server certificate.

Pyshop uses clear and simple ACLs to manage privileges:

  • an installer group that can only download release files,
  • a developer group that can download and upload release files and browse the website,
  • an admin group that has developer privileges and accounts management.

Since pyshop is intended to host private packages, every user, including pip, must be authenticated by login and password.


$ virtualenv pyshop
$ cd pyshop
(pyshop)$ source bin/activate
(pyshop)$ pip install pyshop
(pyshop)$ cp pyshop.sample.ini pyshop.ini
(pyshop)$ vim pyshop.ini  # change the pyshop.cookie_key setting
(pyshop)$ pyshop_setup pyshop.ini
(pyshop)$ pserve pyshop.ini start --log-file=pyshop.log

You should edit the pyshop.ini file in order to configure the pyshop.cookie_key and the host:port that hosts the service. When the server is running visit the website, http://localhost:8000/ by default, to check everything is fine.

For production usage, you should create accounts with the developer group. Visit http://localhost:8000/pyshop/user with the admin account to create accounts.

You also should also use an https reverse proxy. Python packaging core uses HTTP basic authentication: it sends user/password in clear.

Configuring your environment

Here are all configuration files you will need to modify for usual python tools to use your newly deployed private repository.


Configuration used by pip. This is a user file, you can set a developer or the generic pip account.

# when mirroring a package, pyshop retrieves information from PyPI and
# stores it in its database. Be patient, it is not so long.
default-timeout = 120
timeout = 120

index-url = http://pip:changeme@localhost:8000/simple/


If you are using a WSGI server that kills requests if it is too long, like uWSGI or gunicorn, set an appropriate timeout for this service too.

setup.cfg and pydistutils.cfg

setup.cfg and pydistutils.cfg are used when running python develop to install your package or when using easy_install. You should use a generic account with installer privileges only, shared by all developers.

This setting can be set per project or in user $HOME (see setuptools documentation for details)

index-url = http://pip:changeme@localhost:8000/simple/

This should work now:

python develop


Configuration used by setuptools to upload files. All developers should have this configuration in their $HOME to upload packages.

index-servers =

username: admin  # or create an account in pyshop admin interface
password: changeme
repository: http://localhost:8000/simple/

This should work now:

python sdist upload -v -r pyshop

Missing Features

Developer cannot add other accounts to give them upload right to their project. This can be done in the database or in the pyshop shell by an administrator.

$ pyshop_shell pyshop.ini
In [1]: pkg = Package.by_name(session, u'pyshop')
In [2]: pkg.owners.append(User.by_login(session, u'admin'))
In [3]: session.commit()



  • Fix pyshop_setup command with Python 3


  • Add compatibility with python 3.3 and 3.4
  • Add ldap support (mgoacolou)
  • Replace scss by bootstrap (mgoacolou)


  • Authorize developper to upload a patched version of a mirrored package without any restriction. Some mirrored package may have bugs that are critical for you, and it’s better to get a mirrored package than rely on an external sources.


  • Fix support of SQLAlchemy 0.9.x
  • Fix packaging (missing LICENSE)


  • Fix postgresql admin account pages


  • Add support for posgresql


  • Remove some links in the simple route.
    • Don’t display home pages
    • Don’t display download links in case there is archive available. (That fix some install for south for example)


  • Fix mirroring of package when the case and underscore are not “correct”


  • Fix mirroring of external links browsed (in case it’s not a package)


  • Fix packaging


  • Fix tests for python 2.6 (unittest2 required and be installed manually)
  • Fix pyramid 1.2 compatibility
  • Rename command pyshop_install to python_setup
  • Give the possibility to use the prefix_route via the settings ‘pyshop.prefix_route’
  • Give the possibility to disable xmlrpc servive via ‘pyshop.enable_xmlrpc’


  • Tolerant underscore/hyphen usage in package name
  • Tolerant with trailing slash in urls


  • Fix unit tests


  • add key “pyshop.mirror.cache.ttl” in config file. This settings allow to set the cache time of a package before refresh it on pypi.
  • add a button in the web interface to force the refresh of mirrored package. This permit to force reset the ttl of a package on the web interface.
  • add key “pyshop.upload.rewrite_filename” in config file. This settings disable the rename of package file uploaded on the server.
  • change “satanize” to “sanitize” keys in config file. Modify this settings in your config file after a migration.
  • add key “pyshop.mirror.wheelify” in config file. This settings require users to use recent version of pip and setuptools virtualenv 1.10.1 is OK. This is experimental. User and Proxy Server must run the same OS on the same architecture to use that feature.


  • Use requests for xmlrpc queries too. - validate certificate if https is used - unified proxies configuration (use environment vars)
  • SAWarning/DeprecationWarning removed - Fix mirroring link for external files


  • Mirror the download_url of the release file
  • Handle hiphen and underscore [fizyk]
  • Enhance mimetime handling [fizyk]
  • Bugfixes and DeprecationWarning removed


  • Fix package version comparison
  • Handle bdist_wheel format

To handle the wheel format, (some package like Twisted 13 use it), for previous install, you must run a migration script like this.

$ pyshop_migrate development.ini 0.7.5

The sqlite database file will be altered, YOU MAY backup it before run the script.


  • Fix local package usage (broken since 0.7.1) [fizyk]


  • Remove all certificates and extra handling for PyPI validation as PyPI now uses a certificate that can be validated without these. [disko]


  • Remove unused certificates for pypi validation


  • Securize download from pypi by forcing https and validate certificate certificate chain is embed in the pyshop package
  • Fix package order on web page


  • Sanitize version number on upload. This is configurable with settings pyshop.upload.satanize and pyshop.upload.satanize.regex
  • Settings pyshop.satanize and pyshop.satanize.regex have been renamed to pyshop.mirror.satanize and pyshop.mirror.satanize.regex


  • Fix first connection of the web application
  • Fix the usage of http proxy (forcing request version)


  • Add Link to display all release versions
  • Improve navigation
  • Fix ugly version number sorting


  • Fix release file upgrade (allow developper to override release file)
  • Rename user views to account
  • Add view to let the connected user to update his account


  • The setting pyshop.satanize.reg has been renamed to pyshop.satanize.regex
  • The setting cookie_key has been renamed to pyshop.cookie_key
  • Fix bug on package upload. don’t close the stream while writing it.
  • Add basic tests on packages view


Packaging Issue.


Initial version.

  • work with pip, setuptools
  • mirror packages
  • upload packages
  • secure access with login/password
  • create/update accounts
  • tests for python 2.7 only
  • compatible with python 2.6

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pyshop, version 1.0.1
Filename, size File type Python version Upload date Hashes
Filename, size pyshop-1.0.1.tar.gz (273.1 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page