python library for interacting with Open Tree of Life resources
Jupyter Notebook Python Other
Latest commit 9fee31e Dec 8, 2016 @jimallman jimallman committed on GitHub Merge pull request #172 from OpenTreeOfLife/pickle-ott-ranks
Pickle ott ranks
Permalink
Failed to load latest commit information.
dev test juggling Oct 5, 2016
doc big reformat to be closer to pep-8 compliant Oct 6, 2016
examples big reformat to be closer to pep-8 compliant Oct 6, 2016
extras big reformat to be closer to pep-8 compliant Oct 6, 2016
peyotl simplify pickling logic Dec 6, 2016
scratch refactored logging and config locations Sep 27, 2016
scripts merge Oct 6, 2016
tests fix of var name Oct 24, 2016
tutorials big reformat to be closer to pep-8 compliant Oct 6, 2016
.gitignore Changes to existing files for taxonomic amendments Jun 21, 2016
.travis.yml adding py 3.5 to travis Oct 5, 2016
CONTRIBUTORS.txt start of a logger test Sep 29, 2016
License.txt Authors file merged with Contributors. License authors fixed Apr 9, 2014
MANIFEST.in explit inclusion of default.conf to see if this fixes the travis failure Oct 5, 2016
README.md Fixed @jeetsukumaran's name Sep 3, 2015
README.rst resolved merge conflicts Nov 21, 2014
TESTING.md typo in docs and newline at EOF added Oct 22, 2014
THANKS.txt initial commit Feb 8, 2014
bootstrap.sh Changes to existing files for taxonomic amendments Jun 21, 2016
clean.sh primarily bash var braces Oct 3, 2016
ez_setup.py big reformat to be closer to pep-8 compliant Oct 6, 2016
other-ot-peyotl-dependencies-snapshot.txt more use by phylesystem-api Oct 7, 2016
post-to-pypi.sh primarily bash var braces Oct 3, 2016
requirements.txt syncing requirements Oct 5, 2016
setup.cfg working on pypi splash page from rst Nov 14, 2014
setup.py big reformat to be closer to pep-8 compliant Oct 6, 2016
test.sh Adds bracket_ingroup option to newick writing Oct 22, 2014

README.md

peyotl

Build Status

peyotl is a python package written to make it easier to interact with the software produced by the Open Tree of Life project. Specifically, to:

  1. interact with a local version of the phylesystem repository of curated phylogenetic studies ;

  2. call web services associated with the studies (served by web app running the phylesystem-api code);

  3. call web services associated with taxonomic resolution services (running taxomachine );

  4. call web services associated with Open Tree of Life's "synthetic" estimate of the tree of life (running treemachine);

  5. call web services associated with an annotation database (that we have not built yet)

Currently peyotl is used to implement most of the functionality in the phylesystem-api backend of the study curation tool.

Instructions

You probably want to be using a virtualenv. Then you can:

$ pip install -r requirements.txt
$ python setup.py develop

For full(er) documentation, check out our http://opentreeoflife.github.io/peyotl/ documentation site.

Testing

Use:

python setup.py test

to trigger the unittests. The testing page of the documentation site describes the other tests scripts.

Thanks

peyotl is primarily written by Mark Holder, Emily Jane McTavish, and Jim Allman, but see the contributors file for a more complete list of people who have contributed code.

The fabulous Karl Gude created the logo.

Several parts of the setup.py, logging, documentation, and test suite were based on Jeet Sukumaran's work in the DendroPy package.

The tree/node iteration functions in peyotl.phylo.tree are also adapted from DendroPy.

The sortattr.xslt stylesheet (which is only used in round-trip testing) is from http://stackoverflow.com/questions/1429991/using-xsl-to-sort-attributes

The peyotl.phylesystem.git_actions (and the tests) were a part of the api.opentreeoflife.org repo which was primarily the work of Duke Leto (at that time).

Jim Allman, Karen Cranston, Cody Hinchliff, Mark Holder, Peter Midford, and Jonathan Rees all participated in the discussions that led to the NexSON mapping.

The peyotl/test/data/nexson/phenoscape/nexml test file is from https://raw.github.com/phenoscape/phenoscape-data/master/Curation%20Files/completed-phenex-files/Characiformes/Buckup_1998.xml PhenoscapeKB, [U.S. National Evolutionary Synthesis Center], http://kb.phenoscape.org; [Feb 16, 2014] The citation for the data is in the nexml doc itself.

peyotl includes the ez_setup.py tool from setuptools To satisfy the Python Software Foundation license we note here that peyotl does not alter the python sourcee code itself. By installing the package you enable the python interpreter to find the code included in this package for interacting with open tree of life data and web services.


Etymology: According to Wikipedia, peyotl is the Nahuatl word for Lophophora williamsii.