Metadata-Version: 2.3
Name: envkit
Version: 0.5.0
Summary: A lightweight package for parsing environment variables
Author: Théo Guérin
Author-email: Théo Guérin <contact@theo-guerin.dev>
License: MIT License
         
         Copyright (c) 2024 Theo Guerin
         
         Permission is hereby granted, free of charge, to any person obtaining a copy
         of this software and associated documentation files (the "Software"), to deal
         in the Software without restriction, including without limitation the rights
         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
         copies of the Software, and to permit persons to whom the Software is
         furnished to do so, subject to the following conditions:
         
         The above copyright notice and this permission notice shall be included in all
         copies or substantial portions of the Software.
         
         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
Requires-Python: >=3.12
Description-Content-Type: text/markdown

# EnvKit

[![PyPI - Version](https://img.shields.io/pypi/v/envkit)](https://pypi.org/project/envkit/)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/envkit)](https://pypi.org/project/envkit/)

A lightweight package for parsing environment variables.

## Installation

```bash
pip install envkit
```

## Usage

```python
from envkit import Env

# Required string with minimum length
api_key = Env.str("API_KEY", min_length=32)

# Optional integer with default and range
port = Env.int("PORT", default=8080, min_value=1, max_value=65535)

# Boolean with default
debug = Env.bool("DEBUG", default=False)

# Enum parsing
log_level = Env.enum("LOG_LEVEL", enum=LogLevel, default=LogLevel.INFO)
```

## Contributing

Contributions are welcome!
Whether you want to report an issue, suggest an improvement, or submit a pull
request, your help is appreciated.

If you’re new to open source, feel free to participate as well — the project is
open to contributors of all experience levels.

- Open an issue for bugs, ideas, or questions
- Submit a pull request with changes or enhancements
- Documentation and test improvements are also valuable

Everyone is welcome to contribute.
