Metadata-Version: 2.4
Name: crustypy-instance
Version: 0.2.1
Summary: Generated with CrustyPy.
Author: Micael Jarniac
Author-email: Micael Jarniac <micael@jarniac.dev>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 1 - Planning
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Typing :: Typed
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3.15
Requires-Dist: loguru>=0.7.3
Requires-Python: >=3.14
Project-URL: homepage, https://github.com/MicaelJarniac/crustypy-instance
Project-URL: source, https://github.com/MicaelJarniac/crustypy-instance
Project-URL: download, https://pypi.org/project/crustypy-instance/#files
Project-URL: changelog, https://github.com/MicaelJarniac/crustypy-instance/blob/main/docs/CHANGELOG.md
Project-URL: documentation, https://crustypy-instance.readthedocs.io
Project-URL: issues, https://github.com/MicaelJarniac/crustypy-instance/issues
Description-Content-Type: text/markdown

<div align="center" markdown="1">

  [![Discord][badge-chat]][chat]
  <br>
  <br>

  | | ![Badges][label-badges] |
  |:-|:-|
  | ![Build][label-build] | [![Nox][badge-actions]][actions] [![Python Semantic Release][badge-semantic-release]][semantic-release] [![PyPI][badge-pypi]][pypi] [![Read the Docs][badge-docs]][docs] |
  | ![Tests][label-tests] | [![coverage][badge-coverage]][coverage] [![pre-commit][badge-pre-commit]][pre-commit] [![asv][badge-asv]][asv] |
  | ![Standards][label-standards] | [![SemVer 2.0.0][badge-semver]][semver] [![Conventional Commits][badge-conventional-commits]][conventional-commits] |
  | ![Code][label-code] | [![uv][badge-uv]][uv] [![Ruff][badge-ruff]][ruff] [![Nox][badge-nox]][nox] [![ty][badge-ty]][ty] |
  | ![Repo][label-repo] | [![GitHub issues][badge-issues]][issues] [![GitHub stars][badge-stars]][stars] [![GitHub license][badge-license]][license] [![All Contributors][badge-all-contributors]][contributors] [![Contributor Covenant][badge-code-of-conduct]][code-of-conduct] |
</div>

<!-- Badges -->
[badge-chat]: https://img.shields.io/badge/dynamic/json?color=green&label=chat&query=%24.approximate_presence_count&suffix=%20online&logo=discord&style=flat-square&url=https%3A%2F%2Fdiscord.com%2Fapi%2Fv10%2Finvites%2FYe9yJtZQuN%3Fwith_counts%3Dtrue
[chat]: https://discord.gg/Ye9yJtZQuN

<!-- Labels -->
[label-badges]: https://img.shields.io/badge/%F0%9F%94%96-badges-purple?style=for-the-badge
[label-build]: https://img.shields.io/badge/%F0%9F%94%A7-build-darkblue?style=flat-square
[label-tests]: https://img.shields.io/badge/%F0%9F%A7%AA-tests-darkblue?style=flat-square
[label-standards]: https://img.shields.io/badge/%F0%9F%93%91-standards-darkblue?style=flat-square
[label-code]: https://img.shields.io/badge/%F0%9F%92%BB-code-darkblue?style=flat-square
[label-repo]: https://img.shields.io/badge/%F0%9F%93%81-repo-darkblue?style=flat-square

<!-- Build -->
[badge-actions]: https://img.shields.io/github/actions/workflow/status/MicaelJarniac/crustypy-instance/ci.yml?branch=main&style=flat-square
[actions]: https://github.com/MicaelJarniac/crustypy-instance/actions
[badge-semantic-release]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079?style=flat-square
[semantic-release]: https://github.com/python-semantic-release/python-semantic-release
[badge-pypi]: https://img.shields.io/pypi/v/crustypy-instance?style=flat-square
[pypi]: https://pypi.org/project/crustypy-instance
[badge-docs]: https://img.shields.io/readthedocs/crustypy-instance?style=flat-square
[docs]: https://crustypy-instance.readthedocs.io

<!-- Tests -->
[badge-coverage]: https://img.shields.io/codecov/c/gh/MicaelJarniac/crustypy-instance?logo=codecov&style=flat-square
[coverage]: https://codecov.io/gh/MicaelJarniac/crustypy-instance
[badge-pre-commit]: https://img.shields.io/badge/pre--commit-enabled-brightgreen?style=flat-square&logo=pre-commit&logoColor=white
[pre-commit]: https://github.com/pre-commit/pre-commit
[badge-asv]: https://img.shields.io/badge/benchmarked%20by-asv-blue?style=flat-square
[asv]: https://github.com/airspeed-velocity/asv

<!-- Standards -->
[badge-semver]: https://img.shields.io/badge/SemVer-2.0.0-blue?style=flat-square&logo=semver
[semver]: https://semver.org/spec/v2.0.0.html
[badge-conventional-commits]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow?style=flat-square
[conventional-commits]: https://conventionalcommits.org

<!-- Code -->
[badge-uv]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json&style=flat-square
[uv]: https://github.com/astral-sh/uv
[badge-ruff]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json&style=flat-square
[ruff]: https://github.com/astral-sh/ruff
[badge-nox]: https://img.shields.io/badge/%F0%9F%A6%8A-Nox-D85E00.svg?style=flat-square
[nox]: https://github.com/wntrblm/nox
[badge-ty]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json&style=flat-square
[ty]: https://github.com/astral-sh/ty

<!-- Repo -->
<!-- Absolute links: this file is also the PyPI description, where relative ones break. -->
[badge-issues]: https://img.shields.io/github/issues/MicaelJarniac/crustypy-instance?style=flat-square
[issues]: https://github.com/MicaelJarniac/crustypy-instance/issues
[badge-stars]: https://img.shields.io/github/stars/MicaelJarniac/crustypy-instance?style=flat-square
[stars]: https://github.com/MicaelJarniac/crustypy-instance/stargazers
[badge-license]: https://img.shields.io/github/license/MicaelJarniac/crustypy-instance?style=flat-square
[license]: https://github.com/MicaelJarniac/crustypy-instance/blob/main/LICENSE
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[badge-all-contributors]: https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square
<!-- ALL-CONTRIBUTORS-BADGE:END -->
[contributors]: https://github.com/MicaelJarniac/crustypy-instance#contributors
[badge-code-of-conduct]: https://img.shields.io/badge/Contributor%20Covenant-3.0-4baaaa?style=flat-square
[code-of-conduct]: https://github.com/MicaelJarniac/crustypy-instance/blob/main/docs/CODE_OF_CONDUCT.md
<!---->

# CrustyPy Instance

Welcome to **CrustyPy Instance's** documentation!

Generated with CrustyPy.

[Read the Docs][docs]

## Installation

### PyPI
[*crustypy-instance*][pypi] is available on PyPI:

```bash
# With uv
uv add crustypy-instance
# With pip
pip install crustypy-instance
# With Poetry
poetry add crustypy-instance
```

### GitHub
You can also install the latest version of the code directly from GitHub:
```bash
# With uv
uv add git+https://github.com/MicaelJarniac/crustypy-instance
# With pip
pip install git+https://github.com/MicaelJarniac/crustypy-instance
# With Poetry
poetry add git+https://github.com/MicaelJarniac/crustypy-instance
```

## Usage
For more examples, see the [full documentation][docs].

```python
from crustypy_instance import make_greeting

print(make_greeting("World"))
```

### Logging
*crustypy-instance* logs with [Loguru](https://github.com/Delgan/loguru), disabled by default as befits a library. Opt in from your application:

```python
from loguru import logger

logger.enable("crustypy_instance")
```

## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

More details can be found in [CONTRIBUTING](https://github.com/MicaelJarniac/crustypy-instance/blob/main/docs/CONTRIBUTING.md).

## Contributors
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
</table>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

## License
[MIT][license]

This project was created with the [MicaelJarniac/crustypy](https://github.com/MicaelJarniac/crustypy) template.
