Metadata-Version: 2.1
Name: clive-log
Version: 0.0.1
Summary: A CLI live logging package
Home-page: https://github.com/heidtn/clive_log
Author: Nathan
Author-email: strigusconsilium@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.6
Description-Content-Type: text/markdown

# CLIVE_LOG

This is a simple library for quick python debugging of live data streams.  It's intended to run in the command line only
and to be very compact.  The primary goals of the project are to not use any external dependencies (besides the python libraries)
and to try and keep the total LOC under ~1000 to make it accessible.

Currently supported fields are:
* Text fields
* Cell fields
* Graph fields

### Getting started

Check the examples folder for some basic demos on how to use this library.

The general usage is:
```python
import clive_log
context = clive_log.Context("test")
context.add_text_field("text_field1")
while True:
    context.write_text_field("text_field1", "new text to write")
    context.display()
```

![clive_log Demo](extras/clive_demo.gif)


### Known Issues

There are still some issues with the system, namely:
* artifacts when resizing
* nonfunctional in terminal multiplexers

### Future Features

Some things I would like to eventually add:
* config parameters for how to print everything
* resize cleanup
* progress bars
* tables

### License

MIT License

