Pybraries¶
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(keywords='visualization', sort='stars', platform='pypi')
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 method names in the left sidebar 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¶
Check out the full pybraries documentation.
Getting Help¶
1. Check out the pybraries docs. 1. Check out the libraries.io docs. 1. Open an issue on GitHub or tag a question on Stack Overflow with “pybraries”.
Contributing¶
Contributions are welcome and appreciated! See Contributing.