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(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

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.

License

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

pybraries-0.3.1.tar.gz (9.3 kB view details)

Uploaded Source

Built Distribution

pybraries-0.3.1-py3-none-any.whl (10.4 kB view details)

Uploaded Python 3

File details

Details for the file pybraries-0.3.1.tar.gz.

File metadata

  • Download URL: pybraries-0.3.1.tar.gz
  • Upload date:
  • Size: 9.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.3

File hashes

Hashes for pybraries-0.3.1.tar.gz
Algorithm Hash digest
SHA256 2941031a77a6b36fdf79f374614491a659ef9adef63f38d1adf679f85c88c556
MD5 8499c68302ee4878708ad9f3a6dc147d
BLAKE2b-256 52538ff1c420d9f6e1580f064ace902b7c5e8b9f524de03a7be6903c60952402

See more details on using hashes here.

File details

Details for the file pybraries-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: pybraries-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 10.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.3

File hashes

Hashes for pybraries-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6e0f1616fa261167b60a9b5d81a2e4faeb8d2c890c4769a01dd4046d027bdf23
MD5 0fbc635183cc647081fae094d7c7de8c
BLAKE2b-256 af22e404dad9d259dee36df23a4041c290a26a7b1fbd083bfaec26fbd060ecbd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page