ProGet Documentation

PyPI Feeds in ProGet

  • Last Modified: 2020-01-11

The Python Package Index (PyPI) is the primary repository for software and libraries written in the Python programming language. As of v5.2, ProGet supports creating PyPI feeds to host and serve in-house Python software packages.

Installing Packages

PyPI packages are installed using pip. To install a package from a ProGet feed, use the following command:

pip install {package-name}=={package-version} -i http://{proget-server}/pypi/{feed-name}/simple 

Creating Packages

To learn how to create a package that can be hosted by ProGet, visit the Packaging Python Projects tutorial.

Publishing Packages

Twine

PyPI packages are pushed to ProGet using twine. To push a package to a ProGet feed, use the following command:

twine upload --repository-url http://{proget-server}/pypi/{feed-name}/legacy <dist>

cURL

PyPI packages may be published to ProGet with cURL using the following syntax:

curl https://{proget-server}/pypi/{feed-name}/upload/<packageName-version.tar.gz> --user <user>:<password> --upload-file <packageName-version.tar.gz>

Technical Limitations

  • ProGet only supports searching package name and summary fields via the XML-RPC API (implemented by PyPI.org), other use-cases of this API are not supported by ProGet
  • Connectors to other PyPI feeds require the PyPI JSON API to be implemented (both ProGet and PyPI.org support this)
  • Package names are generally normalized (as per the PEP503 specs), but packages where versions only differ by - and _ (e.g. my-package 1.0 and my_package 1.1) aren't properly listed under my-package. In addition, UI-based searching does not treat _ and - the same

If these limitations present more than minor inconveniences, please let us know and we can consider fixing/addressing them.

Is this documentation incorrect or incomplete? Help us by contributing!

This documentation is licensed under CC-BY-SA-4.0 and stored in GitHub.

Generated from commit 46e90aca on master