jk_pypiorgapi

Introduction

This python module provides an API for accessing Python packet information hosted on pypi.org.

Information about this module can be found here:

• github.org
• pypi.python.org

Why this module?

Apparently quite some people would like to retrieve information from pypi.org. As I was not able to find a suitable package quickly that already implemented such behavior I decided to implement an own one and provide it publically.

How to use this module

Import this module

Please include this module into your application using the following code:

import jk_pypiorgapi

Instantiate the API object

In order to access the API you have to instantiate an API object. This is done as shown here:

api = jk_pypiorgapi.PyPiOrgAPI()

NOTE: The reason behind that is simple: Code flexibility. This way modifications and extensions will be possible if some things change with pypi.org. So please first instantiate an API object, then you can use it.

List existing packages

If you want to access a list of all packages hosted on pypi.org, you can use this method:

packageNames = api.listAllPackages()

Please be aware that invoking this method is expensive. The reason why calling is method is expensive is that the package index nowadays has over 16 MBytes in size. Please use this method wisely to avoid server load on pypi.org and do not download the package index too frequently!

Search for packages

Here is an example how to search for specific packages:

for jData in api.iteratePackagesByClassifier(
		searchTerm="jk_pypiorgapi",
		classifiers=[
			"Development Status :: 5 - Production/Stable",
			"Development Status :: 6 - Mature",
		]
	):

	print(jData)		# do something with the search result here

As the method iteratePackagesByClassifier() returns an iterator you need to loop through the results. The objects returned by iteratePackagesByClassifier() is an instance of PyPiPackage which provides the following properties:

Data Type	Name	Description
int	nResultNo	The result index number. This is a counter starting at zero, enumerating all results.
int	nMaxResults	The number of results to be expected. (Don't rely on it, neither can all be iterated if this value is too large, nor does it need to remain unchanged during the iteration.)
str	pkgName	The name of the package.
str	pkgVersion	The version of the package.
str	pkgDescription	The description of the package.

For a list of classifiers see: https://pypi.org/classifiers/

Get information about an existing packages

If you want to retrieve information about a certain package hosted on pypi.org, you can use this method:

jData = api.getPackageInfoJSON("jk_pypiorgapi")

This will look up the package jk_pypiorgapi and retrieve all information about it as a JSON data structure. This method directly provides the information pypi.org provides via its API.

NOTE: For experimenting purposes you might want to display this data in an easy way. jk_json provides a convenience method named prettyPrint() for that purpose:

import jk_json

jk_json.prettyPrint(jData)

Dependencies

This module has the following dependencies:

• bs4 for HTML parsing
• jk_furl for more convenient URL handling
• jk_prettyprintobj for pretty printing objects for debugging

Author(s)

• Jürgen Knauth: [email protected]

License

This software is provided under the following license:

• Apache Software License 2.0