Metadata-Version: 2.4
Name: cligraph
Version: 0.1.1
Summary: A package inspired by tqdm, that adds an updateable graph to the cli for tracking a value within a loop.
Author: Brayden Cloutier
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: logging

# cligraph

## What is this package for?
This package prints an updating graph that can track a specified value throughout a loop.

## Installing the package
### pip install
```bash
pip install cligraph
```
### git clone
```bash
git clone https://github.com/BraydenAC/cligraph.git
cd Conversation-Inference-Tree
```
## Basic Usage Example
```python
from cligraph import CLIGraph
import time

#Instantiate the graph object outside the loop
graph = CLIGraph(1, 5, desc='Example Graph')
example_nums = [2,2,2,3,3,4,4,5,6,5,4,5,5,4,3,3,3,3,3,2,2,1,2,3,3]

#Loop through the ints one at a time
for num in example_nums:
    #send the current num to the graph to be visualized
    graph.update(num)
    time.sleep(0.5)
```

## Liscense
*Apache 2.0*
