Skip to main content
Donate to the Python Software Foundation or Purchase a PyCharm License to Benefit the PSF! Donate Now

An interface to the Wormbase REST API

Project description

PyWormbase

This package is an interface to the WormBase ParaSite REST API. You can use it in your Python programs to retrieve data from the WormBase API without needing to learn the details of REST API interactions. The function names are intelligent and documentation is provided. This package is targeted toward Wormbase users who want to get data from Wormbase faster than using the web site.

Installation

Installation is simple with pip. Simply run

> pip install pywormbase

to retrieve this package from the PyPI package index.

Usage

Wormbase's API is free and open. No credentials, keys, or tokens are needed to access it. This makes PyWormbase easy to use in scripts, too. First, import PyWormbase, then instantiate a WormbaseClient object:

>>> import pywormbase
>>> api = pywormbase.WormbaseClient()

A WormbaseClient object will have a variety of member functions that provide access to Wormbase API endpoints. You can use dir(api) to see all functions available (or read the associated documentation in the Github wiki).

Support

If you use PyWormbase and are experiencing problems with the package, or if you have a request for an additional feature, please file an issue at https://github.com/c-anna/PyWormbase/issues.

A note: PyWormbase is a wrapper around the WormBase ParaSite REST API. This API is subject to change and so both the content and format of the responses may change infrequently. While every effort will be made to keep this package aligned with the output of the REST API, it is still possible for scripts relying on this package to change their execution results even if no code changes were made. If you use PyWormbase and notice a change in a function's execution, please open an issue on Github.

License

PyWormbase is free and open-source, licensed under the MIT license. If you are using this software academically or professionally, please acknowledge this package and my Github page, https://github.com/c-anna, somewhere in your final product.

     . .  .  .  . . .
   .                  .                   _.-/`/`'-._
   . Thanks for using!.                 /_..--''''_-'
    .    PyWormbase! .                 //        \
     . .  .  .      .`                //-.__\_\.-'
                `..'  _\\\//  --.___ // ___.---.._
                  _- /@/@\  \       ||``          `-_
                .'  ,\_\_/   |    \_||_/      ,-._   `.
               ;   { o    /   }     ""        `-._`.   ;
              ;     `-==-'   /                    \_|   ;
             |        |>o<|  }@@@}                       |
             |       <(___<) }@@@@}                      |
             |       <(___<) }@@@@@}                     |
             |        <\___<) \_.?@@}                    |
              ;         V`--V`__./@}                    ;
               \      tx      ooo@}                    /
                \                                     /
                 `.                                 .'
                   `-._                         _.-'
                       ``------'''''''''------``

Project details


Release history Release notifications

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
pywormbase-0.1.1.tar.gz (9.7 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page