Skip to main content

Simple script for drawing phylogenetic trees

Project description

Lint Typecheck types - Mypy Ruff

Tree Maker

Tree Maker is a Python script that allows you to create and visualize phylogenetic trees in a simple and automated way.

Features

  • Produces phylogenetic trees in PDF format.
  • Customizable label colors and styles.
  • Supports Python 3.10 and higher.

Installation

Option 1: Clone the repository

git clone https://github.com/cfe-lab/cfetree.git
uv tool install .

Option 2: Install directly from the repository

uv tool install git+https://github.com/cfe-lab/cfetree

Usage

Note: tree_maker requires trees be generated from Clustal!

To use Tree Maker, run the following command:

cfetree input.newick output.pdf

Alternatively, import it into your own project:

from cfetree import load_tree, export_tree

t = load_tree("A,B,C;")
export_tree(t, "/tmp/tree.pdf", "My tree")

This will generate a PDF file containing the phylogenetic tree.

Contributing

Contributions to Tree Maker are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request on the GitHub repository.

Development

Use uv to manage the environment.

Install all dev dependencies:

uv sync --extra test --extra dev

Test:

uv run pytest

Lint:

uv run ruff check

Format:

uv run ruff format

Type-check:

uv run mypy cfetree tests

License

Tree Maker is licensed under the GNU General Public License v3.0. See the LICENSE file for more details.

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

cfetree-0.0.0.dev0.tar.gz (99.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cfetree-0.0.0.dev0-py3-none-any.whl (21.3 kB view details)

Uploaded Python 3

File details

Details for the file cfetree-0.0.0.dev0.tar.gz.

File metadata

  • Download URL: cfetree-0.0.0.dev0.tar.gz
  • Upload date:
  • Size: 99.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.12

File hashes

Hashes for cfetree-0.0.0.dev0.tar.gz
Algorithm Hash digest
SHA256 fadd0d62beb9c49eedb66e5355c60c1b326dfb1f1c57768fdfd328c92c386bd1
MD5 fc28f11a2f516aa5fb835aa2cd53a4db
BLAKE2b-256 f3af66f894a147391c5ba391b2c483ccf4c1e7499ce5fa4db0997d678f69189d

See more details on using hashes here.

File details

Details for the file cfetree-0.0.0.dev0-py3-none-any.whl.

File metadata

File hashes

Hashes for cfetree-0.0.0.dev0-py3-none-any.whl
Algorithm Hash digest
SHA256 54e27c49a2d5bbec774a497c12995f6e956e25974724c2619351c4e1c26d82bd
MD5 f2935da38f2278243c7c23e357f76295
BLAKE2b-256 f1ac36517bf7894475c572cddda4540c3b05b5e8cf2c13d8983a6b4cd5852584

See more details on using hashes here.

Supported by

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