[OBSOLETE] Enforcing use of a private PyPI mirror in your setup.py script
Python
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
doc
example_project
restricted_pkg
tests
.gitignore
ChangeLog
LICENSE
MANIFEST.in
README.rst
setup.py

README.rst

restricted_pkg

Obsolete

This package was useful before Python packaging's recent improvements (circa 2013 onwards).

With recent setuptools versions, one can instruct python setup.py upload to only target a given index through a few configuration lines:

# setup.cfg
[register]
repository = https://pypi.example.domain/

[upload]
repository = https://pypi.example.domain/

Due to this native feature, this package is NO LONGER MAINTAINED.

Previous docs

This python package provide a simple wrapper around Distribute to handle private projects. It is mostly intended for use in a package's setup.py script.

It provides the following features:

  • Using a private package index when fetching package dependencies during python setup.py install
  • Restricting the register and upload commands to a private package index, or to disable them completely
  • Easy support for authenticated URLs when accessing the index.

Compatibility

The restricted_pkg package requires Distribute, and supports Python 2.6 and later (including Python3).

Usage

In your setup.py script, ensure you have the following lines:

from setuptools import find_packages
from restricted_pkg import setup

setup(
    ...,
    private_repository="https://@myrepo.example.tld/path/to/repo",
    install_requires=[
        "distribute",
        "restricted_pkg",
    ],
)