Skip to main content

apybiomart

https://img.shields.io/pypi/v/apybiomart.svg Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public. Travis CI build status CircleCI build status Codecov status Documentation Status Updates Python 3 Downloads

Async pythonic interface to BioMart.

Features

apybiomart is a Python module which provides a simple asynchronous interface to Ensembl BioMart. Users can exploit the async interface to schedule multiple queries using all the commodities offered by Python’s asyncio library.

Depending on specific needs, apybiomart offers different entry points:

  • an asynchronous aquery() function, to schedule multiple queries in the same event loop;

  • a synchronous query() function, which can be used for exploratory queries, executed in real time;

  • a set of synchronous find_*() functions, which can be used to retrieve the list of available marts (find_marts()), datasets for a specific mart (find_datasets()), attributes (find_attributes()) and filters (find_filters()) for a specific dataset.

    • a set of related CLI commands also exists to allow exploration of these data from the command line; these are, respectively, apybiomart marts, apybiomart datasets, apybiomart attributes and apybiomart filters. Run apybiomart --help for further details.

Please refer to the Usage section of the documentation for further information.

Background

apybiomart was originally born as a fork of the great pybiomart package.

I was working on a project that employed a series of async calls to several online resources, but I couldn’t manage to perform asynchronous calls to BioMart using that package, so I decided to modify it to better suit my needs. However, it gradually evolved into a very different thing: the original implementation was rewritten and the structure of the package changed a bit, in a way that I found most useful for my purpose.

This said, all the credits go to jrderuiter, which created the original pybiomart package.

Installation

apybiomart only supports Python 3, and can be installed using pip:

pip install apybiomart

Please refer to the Installation section of the documentation for further information.

Credits

This package was created with Cookiecutter and the cc-pypackage project template.

History

0.1.0 (2019-03-26)

  • First development release.

0.1.1 (2019-03-27)

  • Requests are converted to async calls;

  • Code style is clean and Python 3 compatible.

0.1.2 (2019-03-27)

  • Add basic tests.

0.2.0 (2019-03-31)

  • New version with different organisation of classes and functions;

  • Sync query and async aquery functions to query Biomart;

  • Sync list_* functions to retrieve available marts, datasets, filters and attributes.

0.2.1 (2019-04-01)

  • Add tests.

0.2.2 (2019-04-01)

  • Basic functions working and tested;

  • Fix documentation;

  • Update requirements.

0.2.3 (2019-04-02)

  • Update requirements;

  • Fix type hints for query functions;

  • Reorganise query classes into a single class;

  • Update documentation.

0.2.4 (2019-04-04)

  • Fix type hints;

  • Fix docstrings in classes;

  • Add docstrings to main entry points.

0.2.5 (2019-04-09)

  • Fix test files with new BioMart versions;

  • Add script to create test files automatically.

0.2.6 (2019-04-29)

  • Update test files;

  • Fix and update documentation.

0.3.0 (2019-05-05)

  • Change list_* functions names to find_* for better compliance;

  • Update documentation.

0.3.1 (2019-05-11)

  • Fix requirements handling;

  • Add function to check internet connection.

0.3.2 (2019-05-29)

  • Correct minor typos;

  • Update documentation and testfiles.

0.3.3 (2019-07-29)

  • Fix #37 - issue with the requests module not installed.

0.3.4 (2019-08-23)

  • Better handling of filters arguments for query() and aquery() functions;

  • Convert docstrings to Google style;

  • Fix documentation.

0.3.5 (2019-08-25)

  • Relax requirement versions.

0.4.0 (2020-01-26)

  • Add CLI commands for finding marts, datasets, attributes and filters;

  • Change output dataframe column names.

0.5.0 (2020-03-22)

  • Add CLI and Python module options to save outputs to CSV file.

0.5.1 (2020-04-04)

  • Add option to specify the output CSV filename.

0.5.2 (2020-06-06)

  • Update tests and test files;

  • Clean code;

  • Add CI module.

0.5.3 (2020-11-30)

  • Remove deprecated pd.np occurrencies;

  • Update test files.

Metadata

Release files for apybiomart 0.5.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for apybiomart 0.5.3
File Size Uploaded Provenance
apybiomart-0.5.3.tar.gz 18.5 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for apybiomart 0.5.3
File Interpreter ABI Platform
apybiomart-0.5.3-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 28.5 kB

Release files / apybiomart-0.5.3.tar.gz

Download URL apybiomart-0.5.3.tar.gz
Size 18.5 kB
Tags Source
SHA-256 checksum
How to use checksums
0fe723c166c52245b0b5a35d9ff977090049719b74834f365a82fc0c96736988
BLAKE2b-256 checksum
How to use checksums
8f1bf99ef5b60f849b6b4496947fcbda34206f2930ecd13157723467a61d5113
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

Release files / apybiomart-0.5.3-py2.py3-none-any.whl

Download URL apybiomart-0.5.3-py2.py3-none-any.whl
Size 10.0 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
7681e86bca6217c4987ae30ad25b3d1926e75d6d91b3a8f49e2859d990cab53c
BLAKE2b-256 checksum
How to use checksums
56684b4450b43a779083f3443149d8f981f1a399a5c04cd435a1ab13f4fa80f0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

Security for apybiomart 0.5.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page