https://github.com/sylordis/tools

A repo for tools developed through time.
https://github.com/sylordis/tools

Last synced: 9 days ago
JSON representation

A repo for tools developed through time.

• Host: GitHub
• URL: https://github.com/sylordis/tools
• Owner: Sylordis
• License: apache-2.0
• Created: 2024-09-30T15:22:51.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2025-01-09T15:32:09.000Z (28 days ago)
• Last Synced: 2025-01-09T16:39:09.055Z (28 days ago)
• Language: Python
• Size: 47.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Tools

Hello, this is a private repo for tools developed through time. Help yourselves.

## What's in there

### Python modules

Each directory under `src` is a different module.

Each module usually contains either:

* an example file showcasing how it is supposed to be used, usually named `_example.py`.

* a bin file `_bin.py`, which means the module can be run with `--help` argument to get some explanations.

Files in the `standalone` directory can be run as solitary python files, as long as you have the correct requirements installed.

#### Data generation

A small python series of classes to be able to generate data if online generators are not sufficient.

#### Plot layout

A set of classes used as a wrapper around [matplotlib](https://matplotlib.org/) in order to create big layouts of plots with subplots in an easier fashion.

## How to run

* Modules: from `src` directory `python -m  [args]`

* Standalone: `python `

## Unit tests

They exist. Runnable with `pytest` at the root directory of the python modules.

## Help

Each file should have its own documentation and some man pages are being created (when time allows).

## Author & contributors

The only contributor and author is [Sylvain "Sylordis" Domenjoud](https://github.com/Sylordis).

## License

This project is distributed under the [DBAD license](https://dbad-license.org/).

## Bug report

Please report any bug you find at https://github.com/Sylordis/tools/issues

Have fun, stay scripty!