Skip to main content

Apollo 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 Apollo

Examples

from apollo import ApolloInstance
wa = ApolloInstance('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 Apollo 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.1
    • Added user activate/inactivate

    • Added get_creator for user, group and organisms

    • Added omitEmptyOrganisms to get_users

    • Added support for group admins

    • Added support for bulk group creation/deletion

    • Repaired GFF3/Fasta downloading

  • 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


Download files

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

Source Distribution

apollo-3.1.tar.gz (28.7 kB view details)

Uploaded Source

File details

Details for the file apollo-3.1.tar.gz.

File metadata

  • Download URL: apollo-3.1.tar.gz
  • Upload date:
  • Size: 28.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/2.7.14

File hashes

Hashes for apollo-3.1.tar.gz
Algorithm Hash digest
SHA256 a7e4f640141730b513204e5351708bba61ecac6bae16027610e577acac23eb11
MD5 22551b4bed53c2d1fa3c2e5fe0534014
BLAKE2b-256 27a8171e5d67f23a7d6344627539abae94ddb2c75623798519e0435d65f8221b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page