https://github.com/leto/new_opentree_api

temp location for new open tree api with altered history
https://github.com/leto/new_opentree_api

Last synced: about 2 months ago
JSON representation

temp location for new open tree api with altered history

• Host: GitHub
• URL: https://github.com/leto/new_opentree_api
• Owner: leto
• License: bsd-2-clause
• Created: 2014-01-03T20:18:17.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2014-01-03T20:20:40.000Z (about 11 years ago)
• Last Synced: 2024-06-12T18:58:18.114Z (7 months ago)
• Language: Python
• Size: 2.29 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# The Open Tree Of Life API

[![Build Status](https://secure.travis-ci.org/OpenTreeOfLife/api.opentreeoflife.org.png)](http://travis-ci.org/OpenTreeOfLife/api.opentreeoflife.org)

This repository holds the code that runs The Open Tree Of Life API, which talks

to the backend datastore [treenexus](https://github.com/OpenTreeOfLife/treenexus).

# Introduction

See the [Version Control Strategy](https://github.com/OpenTreeOfLife/api.opentreeoflife.org/blob/master/docs/vcs_strategy.md) for more details about design decisions and how to use submodules.

# Deploying

This git repository is meant to be a "web2py application", so you need to

create a symlink in ```$WEB2PY_ROOT/applications``` to the API repo directory:

   cd $WEB2PY_ROOT/application

   # this will make the app available under /api

   ln -sf /dir/with/api.opentreeoflife.org api

# Using the API from the command-line

See [docs/](https://github.com/OpenTreeOfLife/api.opentreeoflife.org/blob/master/docs/) for examples of how to use the API with ```curl```.

# Dealing with large studies

NOTE: This is a proposal and not yet implemented. All studies

are currently under 50MB and have a structure of:

    studies/N/N.json

On the backend, the API will ask treenexus for the directory

containing study ```N```.  If the JSON representing that study

is greater than 50MB, it will be broken into multiple files to

be stored in Git, so they  will be merged together before a

response is sent. This is all transparent to the user of the

OToL API. Only people using the treenexus data files directly

will need to handle this.

These files will have the structure of:

    studies/N/N-0.json

    studies/N/N-1.json

    ....

    studies/N/N-10.json

# Using the API from Python

See

[opentree_client.py](https://github.com/OpenTreeOfLife/api.opentreeoflife.org/blob/master/sample_client/opentree_client.py)

for examples of using the API from Python.

# Authors

See the CREDITS file