Skip to main content

WebApollo API library

Project description

https://travis-ci.org/galaxy-genome-annotation/python-apollo.svg?branch=master Documentation Status

Apollo is a Python library for interacting with WebApollo

Examples

from apollo import WebApolloInstance
wa = WebApolloInstance('https://fqdn/apollo', 'jane.doe@fqdn.edu', 'password')

orgs = wa.organisms.add_organism(
    "Yeast",
    "/path/to/jbrowse/data",
    genus='Saccharomyces',
    species='cerevisiae',
    public=False
)

# Give webapollo a second to process the uploaded organism.
time.sleep(1)

# Then add yourself to permission list
data = wa.users.update_organism_permissions(
    "jane.doe@fqdn.edu",
    "Yeast",
    write=True,
    export=True,
    read=True,
)

Or with the new Arrow client:

$ arrow groups create_group university
{
    "publicGroup": false,
    "class": "org.bbop.apollo.UserGroup",
    "name": "university",
    "users": null,
    "id": 558319
}
# THEN
$ arrow users get_users | \
    jq '.[] | select(.username | contains("@tamu.edu")) | .username' | \
    xargs -n1 arrow users add_to_group university
# OR
$ arrow users get_users | \
    jq '.[] | select(.username | contains("@tamu.edu")) | .username' | \
    paste -s -d',' | \
    xargs arrow group update_membership 558319 --users

History

  • 3.0.4
  • 3.0.3
    • findAllOrganisms works correctly, client side filtering no longer necessary.
  • 3.0.2
    • Patch a bug discovered in io.write, thanks Morgan!
  • 3.0
    • “Arrow” CLI utility
    • More pythonic API and many workarounds for Apollo bugs or oddities
    • Complete package restructure
    • Nearly all functions renamed
  • 2.0
    • Galaxy Functions
    • TTL Cache to work around Galaxy’s behaviour
    • Status and Canned* Clients from @abretaud
  • 1.0
    • Initial release

License

Available under the MIT License

Support

This material is based upon work supported by the National Science Foundation under Grant Number (Award 1565146)

Project details


Release history Release notifications

This version
History Node

3.0.4

History Node

3.0.3

History Node

3.0.2

History Node

3.0

History Node

2.0

History Node

1.0

History Node

0.1

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
apollo-3.0.4.tar.gz (25.6 kB) Copy SHA256 hash SHA256 Source None Nov 17, 2017

Supported by

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