Metadata-Version: 2.1
Name: scriptonite
Version: 1.0.2
Summary: A toolkit for scripting in Python
License: GPL-3.0-or-later
Author: Andrea Mistrali
Author-email: andrea@mistrali.pw
Maintainer: Andrea Mistrali
Maintainer-email: andrea@mistrali.pw
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Description-Content-Type: text/markdown

## SCRIPTONITE

An opinionated Python toolkit for scripting

## Introduction

When writing python utilites and CLI scripts there are some parts that need to be implented each time, like

- logging;
- configuration parsing;
- other nice to have;

We wrote some opinionated implementations, that gives enough flexibility, but reduce the effort required to start writing the core parts of our script.

More details on each submodule can be found in the `docs/` directory of the original repository.

### Install

```
pip intall scriptonite
```

or

clone the original repo, then run

```
poetry update
poetry build
```

then you can install from local copy, that you can find in `dist/` directory

### How to use

#### Logging

```
from scriptonite.logging import Logger

log = Logger()

log.info('Hello World!')
```

#### Configuration

For more complete configuration management, you can use [Dynaconf](https://www.dynaconf.com/)

```
from scriptonite.configuration import Configuration

configuration = Configuration(configfile="config.yaml",
                              env_prefix="MYCONFIG")

```

