Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ernestum/data-samples-printer
Don't be just mean and standard, print histograms as unicode instead!
https://github.com/ernestum/data-samples-printer
Last synced: 21 days ago
JSON representation
Don't be just mean and standard, print histograms as unicode instead!
- Host: GitHub
- URL: https://github.com/ernestum/data-samples-printer
- Owner: ernestum
- License: mit
- Created: 2023-08-30T10:10:24.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-06T09:58:51.000Z (over 1 year ago)
- Last Synced: 2024-11-28T08:50:08.637Z (about 1 month ago)
- Language: Python
- Homepage: https://ernestum.github.io/data-samples-printer/
- Size: 572 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Data Samples Printer
[](https://pypi.python.org/pypi/data-samples-printer/)
[](https://pypi.python.org/pypi/data-samples-printer/)
[](https://pypi.python.org/pypi/data-samples-printer/)
[](https://github.com/woltapp/wolt-python-package-cookiecutter)
---
**Documentation**: [https://ernestum.github.io/data-samples-printer](https://ernestum.github.io/data-samples-printer)
**Source Code**: [https://github.com/ernestum/data-samples-printer](https://github.com/ernestum/data-samples-printer)
**PyPI**: [https://pypi.org/project/data-samples-printer/](https://pypi.org/project/data-samples-printer/)
---
> Don't be just mean and standard, print histograms as unicode instead!
> This project is inspired by [sparklines](https://en.wikipedia.org/wiki/Sparkline) but works for any kind of data samples that can be represented as a histogram.
> Did you ever enjoy being graded by a single number? No? Then why do you do it to your data?
## Installation
```sh
pip install data-samples-printer
```
## Basic Usage
```python
import data_samples_printer as dsp
import numpy as np
s1 = np.random.normal(size=100)
s2 = np.random.normal(size=100, scale=0.2)
# Plain printing
dsp.print(s1)
> ▁ ▃ ▁▃▁ ▃▃▅▇▅█▄▄▄▇▃▃█▄▅▇▄▃▃▁█▅█ ▁▃▃▁▃▁ ▁
# Printing multiple samples aligns their range
dsp.print(s1, s2)
> ▁ ▃ ▁▃▁ ▃▃▅▇▅█▄▄▄▇▃▃█▄▅▇▄▃▃▁█▅█ ▁▃▃▁▃▁ ▁
> ▁▂▃█▄▅▃▂▁
# Printing with labels
dsp.print(normal=s1, squeezed=s2)
> ▁ ▃ ▁▃▁ ▃▃▅▇▅█▄▄▄▇▃▃█▄▅▇▄▃▃▁█▅█ ▁▃▃▁▃▁ ▁ normal
> ▁▂▃█▄▅▃▂▁ squeezed
# Pretty printing
dsp.pprint(s1, s2)
> ▂ ▂▁▁ ▁▂▄▃▁▁▂▂▂▄▃▂█▃▃▂▃▂▂▂▁▃▂▄▃▂ ▁▂▁ ▁▁▂ ▁ ▁ 0.00 ±1.00
> ▁▂▃▆█▅▆▄▁ 0.04 ±0.20
dsp.mprint(normal=s1, squeezed=s2)
> dist | mean | std | name
> -----|------|-----|-----
> `▕▁ ▂▁▁▁▁▁▃▁ ▂▆▂▁▅▅▅█▂▅▃▅█▃▇▆▂▂▂▂▂▂▅▃▁ ▁ ▁ ▂ ▁▏` | -0.04 | ±0.85 | normal
> `▕ ▁ ▁▄▃█▆█▆▂▂ ▏` | 0.01 | ±0.19 | squeezed
> `▕-1.93 2.41▏` |
```
renders as:
dist | mean | std | name
-----|------|-----|-----
`▕▁ ▂▁▁▁▁▁▃▁ ▂▆▂▁▅▅▅█▂▅▃▅█▃▇▆▂▂▂▂▂▂▅▃▁ ▁ ▁ ▂ ▁▏` | -0.04 | ±0.85 | normal
`▕ ▁ ▁▄▃█▆█▆▂▂ ▏` | 0.01 | ±0.19 | squeezed
`▕-1.93 2.41▏` |
## Development
* Clone this repository
* Requirements:
* [Poetry](https://python-poetry.org/)
* Python 3.7+
* Create a virtual environment and install the dependencies
```sh
poetry install
```
* Activate the virtual environment
```sh
poetry shell
```
### Testing
```sh
pytest
```
### Documentation
The documentation is automatically generated from the content of the [docs directory](./docs) and from the docstrings
of the public signatures of the source code. The documentation is updated and published as a [Github project page
](https://pages.github.com/) automatically as part each release.
### Releasing
To make a new release:
```sh
poetry version # Update the version number
poetry run kacl-cli release --modify --auto-link # Update the changelog
git add CHANGELOG.md pyproject.toml
git commit -m "Release "
git tag
git push origin
```
Then create a new release on GitHub with the output of:
```sh
poetry run kacl-cli get
```
[GitHub releases](https://github.com/ernestum/data-samples-printer/releases) and publish it. When
a release is published, it'll trigger [release](https://github.com/ernestum/data-samples-printer/blob/master/.github/workflows/release.yml) workflow which creates PyPI
release and deploys updated documentation.
Then run
```shell
poetry run mkdocs gh-deploy --force
```
to update the documentation.
### Pre-commit
Pre-commit hooks run all the auto-formatters (e.g. `black`, `isort`), linters (e.g. `mypy`, `flake8`), and other quality
checks to make sure the changeset is in good shape before a commit/push happens.
You can install the hooks with (runs for each commit):
```sh
pre-commit install
```
Or if you want them to run only for each push:
```sh
pre-commit install -t pre-push
```
Or if you want e.g. want to run all checks manually for all files:
```sh
pre-commit run --all-files
```
---
This project was generated using the [wolt-python-package-cookiecutter](https://github.com/woltapp/wolt-python-package-cookiecutter) template.