Metadata-Version: 2.4
Name: axelera-miraculix
Version: 0.3.0
Summary: 
Author: Manuel Schmuck
Author-email: manuel.schmuck@axelera.ai
Requires-Python: >=3.8,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
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.13
Classifier: Programming Language :: Python :: 3.14
Provides-Extra: cli
Requires-Dist: jinja2 (>=3.1,<4.0)
Requires-Dist: rich (>=13.5.2,<14.0.0) ; extra == "cli"
Requires-Dist: typer (>=0.9,<0.13) ; extra == "cli"
Description-Content-Type: text/markdown

# Miraculix Library

![release](https://git.axelera.ai/tools/py/miraculix/miraculix-lib/-/badges/release.svg)
![pipeline](https://git.axelera.ai/tools/py/miraculix/miraculix-lib/badges/develop/pipeline.svg?ignore_skipped=true)
![coverage](https://git.axelera.ai/tools/py/miraculix/miraculix-lib/badges/develop/coverage.svg?job=test:pytest)

<a href="http://tools.doc.axelera.ai/py/miraculix/miraculix-lib"><img alt="Static Badge" src="https://img.shields.io/badge/Documentation-orange?logo=readthedocs&logoColor=white"></a>

## Documentation

The main documentation for this project can be found [here](http://tools.doc.axelera.ai/py/miraculix/miraculix-lib).

## Installation

If you want to use this library, add this package to your `pyproject.toml` file:

```toml
[tool.poetry.dependencies]
axelera-miraculix = "<replace with your version requirement>"

[[tool.poetry.source]]
name = "nexus"
url = "http://10.1.5.124/repository/pypi-axe/simple"
priority = "supplemental"
```

When you use `pip` to install this package, you need to add the following option:

```bash
pip install axelera-miraculix-lib --extra-index-url http://10.1.5.124/repository/pypi-axe/simple --trusted-host 10.1.5.124
```

## Development

The development environment is managed with [frankenstein](http://tools.doc.axelera.ai/py/dev/frankenstein). It can be installed with make:

```bash
make install.frankenstein
```

In the background, this will install `frankenstein` via `pipx` and make it available to you as a command line tool. Afterwards, you can run it with:

```bash
frankenstein --help
```

For more information on how to use `frankenstein`, please refer to the [documentation](http://tools.doc.axelera.ai/py/dev/frankenstein).

