Metadata-Version: 2.1
Name: sitri
Version: 2.2.12
Summary: Library for one endpoint config managment
License: MIT
Keywords: packaging,poetry,config,configuration,managment,vault,pydantic,json,yaml,environment
Author-email: Alexander Lavrov <admin@egnod.dev>
Requires-Python: >=3.7,<3.12
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Other Environment
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Provides-Extra: all
Requires-Dist: redis>=4.3.4; extra == "all"
Requires-Dist: vedis>=0.7.1; extra == "all"
Requires-Dist: pyyaml>=6.0; extra == "all"
Requires-Dist: hvac>=0.11.2; extra == "all"
Requires-Dist: pydantic>=1.9.1; extra == "all"
Requires-Dist: orjson>=3.8.1; extra == "all"
Requires-Dist: tomli>=2.0.1; extra == "all"
Requires-Dist: tomli-w>=1.0.0; extra == "all"
Provides-Extra: hvac
Requires-Dist: hvac>=0.11.2; extra == "hvac"
Provides-Extra: orjson
Requires-Dist: orjson>=3.8.1; extra == "orjson"
Provides-Extra: pyyaml
Requires-Dist: pyyaml>=6.0; extra == "pyyaml"
Provides-Extra: redis
Requires-Dist: redis>=4.3.4; extra == "redis"
Provides-Extra: settings
Requires-Dist: pydantic>=1.9.1; extra == "settings"
Provides-Extra: toml
Requires-Dist: tomli>=2.0.1; extra == "toml"
Requires-Dist: tomli-w>=1.0.0; extra == "toml"
Provides-Extra: vedis
Requires-Dist: vedis>=0.7.1; extra == "vedis"
Project-URL: documentation, https://sitri.readthedocs.io
Project-URL: repository, https://github.com/Egnod/sitri
Description-Content-Type: text/markdown

<p align="center">
  <a href="https://github.com/elastoo-team/sitri">
    <img src="https://raw.githubusercontent.com/Elastoo-Team/sitri/master/docs/logo.svg">
  </a>
  <h1 align="center">
    Sitri - powerful settings & configs for python
  </h1>
</p>

[![PyPI](https://img.shields.io/pypi/v/sitri)](https://pypi.org/project/sitri/)
[![codecov](https://codecov.io/gh/Elastoo-Team/sitri/branch/master/graph/badge.svg)](https://codecov.io/gh/elastoo-team/sitri)
[![Maintainability](https://api.codeclimate.com/v1/badges/625f1d869adbf4128f75/maintainability)](https://codeclimate.com/github/Elastoo-Team/sitri/maintainability)
![Code Climate technical debt](https://img.shields.io/codeclimate/tech-debt/Elastoo-Team/sitri)
[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2FElastoo-Team%2Fsitri%2Fbadge&style=popout)](https://actions-badge.atrox.dev/Elastoo-Team/sitri/goto)
[![Read the Docs](https://img.shields.io/readthedocs/sitri)](https://sitri.readthedocs.io)

Sitri - library for managing authorization and configuration data from a single object with possibly different or identical providers

#  Installation

```bash
poetry add sitri -E "all"
```

or
```bash
pip3 install sitri[all]
```

*Extras* packs and providers:

    1. all - all providers and settings module.
    2. settings - pydantic, providers with settings-support.
    3. redis - for redis provider.
    4. hvac - for HashiCorp Vault provider.
    5. vedis - for vedis provider.
    6. pyyaml - for YAML provider.
    7. orjson - speed-up your json provider (optional).


# Basics with SystemProvider

```python
from sitri.providers.contrib import SystemConfigProvider
from sitri import Sitri

conf = Sitri(
    config_provider=SystemConfigProvider(prefix="basics"),
)
```
System provider use system environment for get config data. For unique - sitri lookup to "namespace" by prefix.

Example:

*In console:*
```bash
export BASICS_NAME=Huey
```

*In code:*
```python
name = conf.get_config("name")

print(name)  # output: Huey
```

#  Docs
Read base API references and other part documentation on https://sitri.readthedocs.io/

