treeplots 0.10.6

CLI tool to create tree views from a csv file with child-parent relationships.

plot-tree

Description

plot-tree creates tree views from a csv file with child-parent relationships. It supports time-based snapshots and generates hierarchical data visuals in meraid, yaml, and text-tree formats.

Setting Up the Project

1. Clone the repository:

   git clone <repository-url>
   cd plot-tree
   

2. Make sure base python verison is >=3.11

   • if base python is lower than 3.11, you can use conda to create a new environment with Python 3.11:

    conda create -n py311 python=3.11
    conda activate py311
    which python
   

   • then use poetry to create a new virtual environment with python 3.11

    poetry env use python3.11
   

3. Install Poetry if has not installed: https://python-poetry.org/docs/#installation

    pipx install poetry
   

4. Install Python dependencies using Poetry:

   poetry install
   

   This command will install all Python packages specified in pyproject.toml, including:

   • pyyaml version ^6.0.1
   • anytree version ^2.12.1

Run all the pytest unit tests

poetry run pytest -v

How to Run

1. Input: put the child and parent entries in child_parent.csv by using the same format of the csv file
2. Run at project's root folder:

poetry run plot

3. Output: at folder /output

treeplots cli

pip install treeplots
treeplots --help
treeplots -v
treeplots --example
treeplots

cli publish

poetry version patch
poetry version minor
poetry publish --build
poetry publish --build --dry-run
tox -e release