Metadata-Version: 2.1
Name: Sparkback
Version: 0.2.0
Summary: Sparklines Library
Home-page: https://github.com/mmichie/sparkback
Author: Matt Michie
Author-email: mmichie@gmail.com
Requires-Python: >=3.8.1
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Libraries
Requires-Dist: requests (>=2.31.0,<3.0.0)
Description-Content-Type: text/markdown

sparkback
=========

A Python library for generating sparklines.

## Installation

```
$ poetry install
$ poetry shell
$ bin/spark --help
```

## Usage
You can use sparkback from the command line or in your Python scripts.

## Command Line

Run sparkback with a series of numbers:

```
spark --ticks default 10 20 30 40 50
```


You can also use different styles of ticks:

```
spark --ticks block 10 20 30 40 50
spark --ticks ascii 10 20 30 40 50
spark --ticks numeric 10 20 30 40 50
spark --ticks braille 10 20 30 40 50
spark --ticks arrows 10 20 30 40 50
```

Use the --stats option to display statistics about your data:

```
spark --ticks default 10 20 30 40 50 --stats
```

## Python API

You can also use sparkback in your Python scripts:

```
import sparkback

data = [10, 20, 30, 40, 50]
ticks = sparkback.scale_data(data, sparkback.TICKS_OPTIONS["default"])
sparkback.print_ansi_spark(ticks)
```

## See also:

* https://github.com/ajacksified/Clark/
* https://github.com/holman/spark


