Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

API for interacting with

Project Description

Python API for the Interactive Tree of Life (iTOL)

Created by Albert Wang (albertyw at

With Complements to: iTOL (Interactive Tree of Life), Python requests package.

This iTOL API allows local software to upload trees to iTOL using and export uploaded trees using using direct Python calls or through shell. An active internet connection to the iTOL website is required.


pip install itolapi

Uploading Trees To iTOL (

From Command Line

(If you need to do anything more than displaying basic tree structures, you must call the Python iTOL API from within a Python program)

$ /path/to/example.tree

From Python

Running from a python program is much more flexible than running from command line and allows access to all iTOL options

from itolapi import Itol
itol_uploader = Itol.Itol()
itol_uploader.add_variable('treeFile', '/path/to/example.tree')
itol_uploader.add_variable('treeFormat', 'newick')
itol_uploader.add_variable('treeName', 'apple')
status = itol_uploader.upload()
assert status != False
# SUCCESS: 1234567890
# 1234567890
# <ItolExport.ItolExport instance at 0x207c5f0>

An example for using the Python iTOL API can found in examples/

Downloading Trees From iTOL (

From Command Line

(If you would like to set any parameters other than the tree id, location to save the file, file format, and whether to display datasets, you must use ItolExport from a Python program)

Options include:
  • -d: show datasets
  • -r: verbose output
  • -h: help

From Python

Running from a Python program allows you to use all the options that iTOL has available.

from itolapi import ItolExport
itol_exporter = ItolExport.ItolExport()
itol_exporter.add_export_param_value('tree', tree_id)
assert format in ['png', 'svg', 'eps', 'ps', 'pdf', 'nexus', 'newick']
itol_exporter.add_export_param_value('format', format)
itol_exporter.add_export_param_value(param_key, param_value)

Valid param_key and param_value values can be found on the iTOL API page.


Send bugs and comments as issues on the Github repository.


To run tests:

pip install tox
python install

To update PyPI:

python sdist upload

Release History

This version
History Node


History Node


History Node


History Node


History Node


History Node


History Node


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
(11.8 kB) Copy SHA256 Hash SHA256
Wheel py3 Jun 11, 2017
(5.8 kB) Copy SHA256 Hash SHA256
Source None Feb 14, 2016

Supported By

Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Google Google Cloud Servers