Skip to main content

A Python wrapper for the libraries.io API

Project description

Travis Status coveralls Documentation Status License Latest Release PyPI - Wheel PyPI - Python Version

Pybraries is a Python wrapper for the libraries.io API.

You can use it to subscribe to email alerts for new versions of open source packages.

You can also use it to find information about many aspects of open source packages and repositories.

The full documentation is hosted at Read the Docs.

Quick Start

Install

Install from PyPI.:

pip install pybraries

Use

Get your API key from libraries.io.

Set your API key as to the LIBRARIES_API_KEY environment variable from the command line with

export LIBRARIES_API_KEY="your_libraries.io_api_key_goes_here"

Import the pybraries package and use it to subscribe to a package.

from pybraries.subscribe import Subscribe

s = Subscribe()

s.subscribe("pypi", "pandas")

Now you’ll get an email update every time a new version of pandas is released.

Here’s another example. Search for projects with visualization as a keyword and python as a language. Sort by the number of stars.

from pybraries.search import Search

search = Search()

info = search.project_search(sort='stars', keywords='visualization', languages='python')
print(info)

A list of dictionaries with project names and other project information is returned.

Note that the Libraries.io API is rate limited to 60 requests per minute.

All libraries.io methods are implemented, except updating a subscription to not include prereleases. This option can be toggled at the libraries.io website.

Search() and Subscribe() are the two classes in this package. See all their available methods by clicking on the methods in the documentation.

Key Terms

host
A repository host platform. e.g. GitHub
owner
A repository owner. e.g. pandas-dev
repo
A repository. e.g. pandas
user
A repository user e.g. a GitHub username. e.g. discdiver
platform
A package manager platform. e.g. PyPI
project
A package or library distributed by a package manager platform. e.g. pandas

Note that many repos and projects share the same name. Many owners and repos also share the same name. Further, many owners are also users. Fun! 😁

Pybraries methods that return one item generally return a dict with information.

Methods that return multiple items return a list of dicts.

Docs

Getting Help

  1. Check out the pybraries docs.
  2. Check out the libraries.io docs.
  3. Open an issue on GitHub or tag a question on Stack Overflow with “pybraries”.

Contributing

  • Contributions are welcome and appreciated! See Contributing.

License

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 pybraries, version 0.2.2
Filename, size File type Python version Upload date Hashes
Filename, size pybraries-0.2.2-py3-none-any.whl (10.3 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size pybraries-0.2.2.tar.gz (8.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page