⚠️ Work in progress, this package is not stable yet.

🌿 pytreesvg

This project is a lightweight Python module to render SVG trees like the following:

The documentation of 🌿 pytreesvg is available at https://pytreesvg.readthedocs.io/en/latest/.

🌿 pytreesvg guarantees that the output SVG file strictly follows the W3C SVG 1.1 (Second Edition) Recommendation.

This module aims to be extremely basic and simple of use, thus it is based on no other existing modules. If you are looking for something more complex please take a look at Graphviz and the existing Python implementations.

---

Work with this repository

Clone the repository

To clone this repository on your local computer please run:

$ git clone https://github.com/PierreGuilmin/pytreesvg.git

⚠️ This project is still under development and not stable yet.

Dev dependencies

• pipenv

Documentation

The documentation of 🌿 pytreesvg is available at https://pytreesvg.readthedocs.io/en/latest/.

It is built with Sphinx and updated every time a commit is pushed on the GitHub repository master branch.

Repository structure

• doc/: directory holding the Sphinx related files.

• images/: project images.

• pytreesvg/: the main Python module.

• temp/: drafts, temporary files and old scripts.

  ⚠️ This directory should not be versionned.

• test/: Python unittest directory for the pytreesvg module.

Emoji commit code table

Please use the following table to commit code:

emoji	meaning	code
🆘	critical bug	:sos:
⚠️	bug	:warning:
🔦	simplification/clarification	:flashlight:
📋	comment	:clipboard:
✨	typos & style	:sparkles:
🎉	new feature	:tada:
☁️	minor modification	:cloud:

For example if you want to commit a new rocket feature — 🎉 new feature, flying rocket! — please do:

# bad syntax
- $ git commit -m 'new feature, flying rocket!'

# good syntax
+ $ git commit -m ':tada: new feature, flying rocket!'