Skip to main content

Simple script for drawing phylogenetic trees

Project description

Lint Typecheck types - Mypy Ruff

CFE Tree Maker

CFE 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

uv tool install cfetree

Usage

Note: CFE Tree Maker requires trees be generated from Clustal!

To use CFE 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 CFE 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

CFE 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-2.0.0.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-2.0.0-py3-none-any.whl (21.0 kB view details)

Uploaded Python 3

File details

Details for the file cfetree-2.0.0.tar.gz.

File metadata

  • Download URL: cfetree-2.0.0.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-2.0.0.tar.gz
Algorithm Hash digest
SHA256 631120630f06488851baefb60fd2d16c388ac9632b2cdd46c1967f9677f45956
MD5 afcea8dfec62d2f9001ed5ad9aff5c92
BLAKE2b-256 fa6c6967276748239459730489ce91a54be86e630d1a8127b5c812ae0b821637

See more details on using hashes here.

File details

Details for the file cfetree-2.0.0-py3-none-any.whl.

File metadata

  • Download URL: cfetree-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 21.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.12

File hashes

Hashes for cfetree-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 020d6ecf7119efa52b189c0f0a43a20b8d91c3dff25bd3a0329dda17ecec508f
MD5 17ca4878e1f1144a6a4fb80239fad224
BLAKE2b-256 14038b09c83b5e49a8dcff783eb97d093d7ef7491e56e8363b568419852f0880

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