Metadata-Version: 2.4
Name: sthali-core
Version: 0.0.8
Summary: A core package for Sthali development
Author-email: Jhunu Fernandes <jhunu.fernandes@gmail.com>
Project-URL: Homepage, https://github.com/project-sthali/sthali-core
Project-URL: Bug Tracker, https://github.com/project-sthali/sthali-core/issues
Project-URL: Source, https://github.com/project-sthali/sthali-core
Project-URL: Documentation, https://project-sthali.github.io/sthali-core
Project-URL: Changelog, https://github.com/project-sthali/sthali-core/releases
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
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: Topic :: Internet :: WWW/HTTP :: HTTP Servers
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development
Classifier: Typing :: Typed
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: cookiecutter>=2.6.0
Requires-Dist: fastapi>=0.115.13
Requires-Dist: mkdocs>=1.6.1
Requires-Dist: pydantic>=2.11.7
Requires-Dist: PyYAML>=6.0.2
Requires-Dist: tomli>=2.2.1
Requires-Dist: typer>=0.16.0
Requires-Dist: uvicorn>=0.34.3
Provides-Extra: dev
Requires-Dist: coverage[toml]>=7.9.1; extra == "dev"
Requires-Dist: ruff>=0.12.0; extra == "dev"
Provides-Extra: tests
Requires-Dist: coverage[toml]>=7.9.1; extra == "tests"
Provides-Extra: stage
Requires-Dist: build>=1.2.1; extra == "stage"
Requires-Dist: coverage[toml]>=7.9.1; extra == "stage"
Dynamic: license-file

<p align="center">
    <a href="https://project-sthali.github.io/sthali-core/images/sthali-core.svg">
        <img src="https://project-sthali.github.io/sthali-core/images/sthali-core.svg" alt="sthali-core">
    </a>
    <em>A core package for Sthali development</em>
</p>
<p align="center">
    <a href="https://github.com/project-sthali/sthali-core/actions/workflows/tests.yml" target="_blank">
        <img src="https://github.com/project-sthali/sthali-core/actions/workflows/tests.yml/badge.svg" alt="">
    </a>
    <a href="https://github.com/project-sthali/sthali-core/actions/workflows/deploy.yml" target="_blank">
        <img src="https://github.com/project-sthali/sthali-core/actions/workflows/deploy.yml/badge.svg" alt="">
    </a>
    <a href="https://github.com/project-sthali/sthali-core/actions/workflows/docs.yml" target="_blank">
        <img src="https://github.com/project-sthali/sthali-core/actions/workflows/docs.yml/badge.svg?branch=development" alt="">
    </a>
</p>

<p align="center">
    <a href="https://project-sthali.github.io/sthali-core/license/" target="_blank">
        <img alt="License" src="https://img.shields.io/github/license/project-sthali/sthali-core">
    </a>
    <a href="https://github.com/project-sthali/sthali-core/releases" target="_blank">
        <img alt="Release" src="https://img.shields.io/github/v/release/project-sthali/sthali-core">
    </a>
</p>

**Docs**: [https://project-sthali.github.io/sthali-core/](https://project-sthali.github.io/sthali-core/)

**PyPI**: [https://pypi.org/project/sthali-core/](https://pypi.org/project/sthali-core/)

**Source**: [https://github.com/project-sthali/sthali-core/](https://github.com/project-sthali/sthali-core/)

**Board**: [https://github.com/users/project-sthali/projects/1/](https://github.com/users/project-sthali/projects/1/)

---

### Requirements

#### Prerequisites
- `python >= 3.10`
- `pip` package manager

#### Runtime Dependencies
This project requires the following Python packages with specific versions:

- `cookiecutter >= 2.6.0`

- `fastapi >= 0.115.13`

- `mkdocs >= 1.6.1`

- `pydantic >= 2.11.7`

- `PyYAML >= 6.0.2`

- `tomli >= 2.2.1`

- `typer >= 0.16.0`

- `uvicorn >= 0.34.3`



#### Optional Dependencies
This project has optional dependencies that can be installed for additional features:

##### dev

- `coverage[toml] >= 7.9.1`

- `ruff >= 0.12.0`


##### tests

- `coverage[toml] >= 7.9.1`


##### stage

- `build >= 1.2.1`

- `coverage[toml] >= 7.9.1`




---

### Instalation

#### Using PYPI

```
pip install sthali-core
```

#### Using GitHub repo

```
git clone https://github.com/project-sthali/sthali-core.git
cd sthali-core
pip install .
```

---

### Usage

nothing to see here, plz disperse
