Skip to main content

PyPIContents is an application that generates a Module Index from the Python Package Index (PyPI) and also from various versions of the Python Standard Library.

Project description

https://raw.githubusercontent.com/LuisAlejandro/pypicontents/develop/docs/_static/banner.svg

PyPIContents is an application that generates a Module Index from the Python Package Index (PyPI) and also from various versions of the Python Standard Library.

PyPI Package Github Releases Github Issues Push Coverage Contributor License Agreement Read The Docs Discord Channel


Current version: 0.2.0

PyPIContents generates a configurable index written in JSON format that serves as a database for applications like pipsalabim. It can be configured to process only a range of packages (by initial letter) and to have memory, time or log size limits. It basically aims to mimic what the Contents file means for a Debian based package repository, but for the Python Package Index.

This repository stores the application. The actual index lives in a different repository and is rebuilt weekly via Github Actions.

For more information, please read the full documentation.

Getting started

Installation

The pypicontents program is written in python and hosted on PyPI. Therefore, you can use pip to install the stable version:

$ pip install --upgrade pypicontents

If you want to install the development version (not recomended), you can install directlty from GitHub like this:

$ pip install --upgrade https://github.com/LuisAlejandro/pypicontents/archive/master.tar.gz

Usage

See USAGE.rst for details.

Getting help

If you have any doubts or problems, suscribe to our Discord server and ask for help. You can also ask your question on StackOverflow (tag it pypicontents) or drop me an email at luis@collagelabs.org.

Contributing

See CONTRIBUTING.rst for details.

Release history

See HISTORY.rst for details.

License

Copyright 2016-2022, PyPIContents Developers (read AUTHORS.rst for a full list of copyright holders).

Released under a GPL-3 License.

Made with 💖 and 🍔

https://raw.githubusercontent.com/LuisAlejandro/pypicontents/develop/docs/_static/author-banner.svg

Web luisalejandro.org · GitHub @LuisAlejandro · Twitter @LuisAlejandro

Project details


Download files

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

Source Distribution

pypicontents-0.2.0.tar.gz (84.3 kB view hashes)

Uploaded source

Built Distribution

pypicontents-0.2.0-py2.py3-none-any.whl (53.5 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page