biorxiv-cli

A Python wrapper for the bioRxiv API.


Keywords
biorxiv, cli
License
MIT
Install
pip install biorxiv-cli==0.1.4

Documentation

bioRxiv-CLI

https://travis-ci.org/jacquerie/biorxiv-cli.svg?branch=master https://coveralls.io/repos/github/jacquerie/biorxiv-cli/badge.svg?branch=master

About

A Python wrapper for the bioRxiv API.

Install

$ pip install biorxiv-cli

Usage

You can use bioRxiv-CLI as a CLI to navigate bioRxiv or as a library to query its API.

CLI

Currently bioRxiv-CLI implements one subcommand:

$ biorxiv read SUBJECTS

This will print the titles of the 30 most recent posts in one of the comma-separated subjects. For example:

https://raw.githubusercontent.com/jacquerie/biorxiv-cli/master/images/biorxiv-cli-screen.png

If no subjects were given, it will assume by default that all subjects were selected.

API

The previous CLI is built on top of a Python library that can be used on its own to query bioRxiv's API. For example:

>>> from biorxiv_cli import Client
>>> client = Client()
>>> client.read([SUBJECTS])

will achieve the same effect as

$ biorxiv read SUBJECTS

Author

Jacopo Notarstefano (@Jaconotar)

License

MIT