Skip to main content

What's the current version for each biological database?

Project description

Bioversions

PyPI PyPI - Python Version PyPI - License DOI Code style: black Powered by the Bioregistry

What's the current version for each biological database?

A daily updated static listing of all current versions (that are incorporated) can be found at https://biopragmatics.github.io/bioversions.

🚀 Installation

$ pip install bioversions

💪 Usage

import bioversions

assert bioversions.get_version('biogrid') == '4.2.192', 'This was true on Dec 5th, 2020!'

# If you want more information, use the resolve() function
bioversion = bioversions.resolve('biogrid')
assert bioversion.version == '4.2.192'

By default, the results are cached and only refreshed once per day with the help of cachier. The cache is stored in ~/.data/bioversions. The cache location can be overridden by setting the BIOVERSIONS_HOME environment variable via pystow.

🌐 Web Application

While https://biopragmatics.github.io/bioversions provides a daily updated static listing of the database, you can run a dynamic version with an API from your shell with:

$ bioversions web

Options can be listed with bioversions web --help.

You can navigate to http://localhost:5000 to see all versions as HTML or programmatically resolve given databases with the http://localhost:5000/database/<name> endpoint like in the following:

import requests

res = requests.get('http://localhost:5000/database/biogrid').json()
assert res['success']
assert res['result']['name'] == 'BioGRID'
assert res['result']['version'] == '4.2.192', 'This was true on Dec 5th, 2020!'

CLI Usage

You can use bioversions get to incorporate the latest versions in your shell scripts or REPL usage like in:

$ wget "https://downloads.thebiogrid.org/Download/BioGRID/Release-Archive/BIOGRID-$(bioversions get biogrid)/BIOGRID-ALL-$(bioversions get biogrid).mitab.zip"

🙏 Contributing

To add more databases to the list, you can create a new submodule of bioversions.sources and extend the bioversions.utils.Getter class to identify the most recent version for your target database. See bioversions.sources.biogrid as an example.

👋 Attribution

⚖️ License

Code is licensed under the MIT License.

🎁 Support

The Bioversions service was developed by the INDRA Lab, a part of the Laboratory of Systems Pharmacology and the Harvard Program in Therapeutic Science (HiTS) at Harvard Medical School.

💰 Funding

The development of the Bioregistry is funded by the DARPA Young Faculty Award W911NF2010255 (PI: Benjamin M. Gyori).

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

bioversions-0.5.5.tar.gz (186.1 kB view details)

Uploaded Source

Built Distribution

bioversions-0.5.5-py3-none-any.whl (49.4 kB view details)

Uploaded Python 3

File details

Details for the file bioversions-0.5.5.tar.gz.

File metadata

  • Download URL: bioversions-0.5.5.tar.gz
  • Upload date:
  • Size: 186.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for bioversions-0.5.5.tar.gz
Algorithm Hash digest
SHA256 5871740cea4aee605c7ff48f17865141f1512ddf8cebf4412d6b009aef3a44b1
MD5 2745409fa48974934407f0ec52461ca5
BLAKE2b-256 849c20cd57cd21b2ecaefa648b93e62621a1fe2bb3543c162e6d846c741bbbc0

See more details on using hashes here.

Provenance

File details

Details for the file bioversions-0.5.5-py3-none-any.whl.

File metadata

  • Download URL: bioversions-0.5.5-py3-none-any.whl
  • Upload date:
  • Size: 49.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for bioversions-0.5.5-py3-none-any.whl
Algorithm Hash digest
SHA256 3f7bd9fb71a60a3c04050418e928f5545dc2d11bb1637bea6a03691773728595
MD5 13b66d9d2cd30bee2153a990980763e2
BLAKE2b-256 f6c9db73fcc6df2db4143ea7aba212172e1d2096d2121f92971f5c55ee546212

See more details on using hashes here.

Provenance

Supported by

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