PyTree

This is a command line directory built in Python to view folders and files in specified directories and list them in a tree fashion.

Pre-requisites

1. Ensure that you have Python version 3.12.0 setup locally, you can set this up using pyenv if you have multiple versions of Python on your local development environment.
2. Poetry is used for managing dependencies, ensure you have that setup locally.
3. Virtualenv Not a hard requirement as poetry should setup a virtual environment for you, but can be used as well to setup a virtual environment.

Setup

1. After cloning the project, install the dependencies required with:

   poetry install

   When using poetry

   Or

   make install

   When using GNU Make, this is a wrapper around the top commend

2. Install pytree in editable mode:

   cd pytree
   pip install -e .

Execution

To execute pytree, go ahead and run the below command:

python pytree --help