Metadata-Version: 2.4
Name: xerini
Version: 0.3.1
Summary: A minimal python library for orchestrating runs of large SQL scripts.
Author-email: "J. Tipan VERELLA" <tipan.verella@gmail.com>
License-Expression: MIT
License-File: LICENSE
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.11
Requires-Dist: networkx>=3.4.2
Requires-Dist: pydantic>=2.10.6
Requires-Dist: pygraphviz>=1.14
Requires-Dist: sql-metadata>=2.17.0
Description-Content-Type: text/markdown

# Sciurus
![coverage](https://gitlab.com/tipanverella/sciurus/badges/main/coverage.svg?job=coverage)

Sciurus is a python library for orchestrating runs of large `SQL` scripts.

You can explore the library by checking out [this documentation](https://sciurus-76b570.gitlab.io/).

You can quickly try it out if you have `docker`:

1. Run the following in the project directory after cloning it:

```zsh
docker build -t xerini -f Dockerfile .
docker run -it xerini zsh
```

2. When inside the container run:


```zsh
make
```
This will run `black`, `pylint`, `mypy`, and `pytest`


3. You can also build and use the deployment container:

```zsh
docker build -t xerini-deploy -f deploy.Dockerfile . --no-cache
docker run -it xerini-deploy python -c "from sciurus.utilities import random_id8; print(random_id8())"
```
This should produce a `random_id8()` string
