becas-python: becas API client

becas-python is the official becas API client for Python.

becas is a biomedical concept annotator available through an HTTP API. It identifies biomedical concepts in text and PubMed publications. You can learn more about becas in its about page.

Installation

Using pip

The preferred method of installation is through pip, and you are encouraged to use a virtualenv:

$ pip install becas

The only hard dependency, requests, will be automatically installed.

Using easy_install

If you really must, and you probably don’t, you can also use easy_install:

$ easy_install becas

Manually

In case you want to install manually, you can either:

• Download or clone the GitHub repository, cd into it and run:

  $ python setup.py install

__or__

• Download becas.py and place it in your project folder.

If you install manually, you should install requests on your own.

Usage

becas-python can be used programmatically or through a command-line interface.

Command-line interface

To use becas as a command-line tool check the Command-line interface documentation.

• Command-line interface
  • Available commands
  • Authentication parameters
  • Optional parameters
  • Using the tool
    • Text annotation
    • Abstract annotation

Programmatically

Learn how to use becas from your Python programs in the becas.py module documentation:

• becas.py module documentation
  • Required configuration
  • Configuration parameters
  • Constants
  • Functions
    • Text annotation
    • Abstract annotation
  • Exceptions

License

Both becas-python and becas are free to use under the Creative Commons Attribution-NonCommercial license.