Metadata-Version: 2.4
Name: flow-config
Version: 0.1.0
Summary: A Python library for event-driven configuration management
Home-page: https://github.com/chinmay29hub/configflow
Author: Chinmay Sonawane
Author-email: Chinmay Sonawane <chinmaysonawane57@gmail.com>
License: MIT License
        
        Copyright (c) 2025 Chinmay Sonawane
        
        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.
        
Project-URL: Homepage, https://github.com/chinmay29hub/configflow
Project-URL: Repository, https://github.com/chinmay29hub/configflow.git
Project-URL: Issues, https://github.com/chinmay29hub/configflow/issues
Project-URL: Documentation, https://configflow.readthedocs.io/
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: watchdog>=2.0
Requires-Dist: PyYAML>=6.0
Requires-Dist: orjson>=3.0
Requires-Dist: pydantic>=2.0
Requires-Dist: python-dotenv>=1.1
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: black>=23.0; extra == "dev"
Requires-Dist: isort>=5.0; extra == "dev"
Requires-Dist: sphinx>=5.0; extra == "dev"
Requires-Dist: sphinx-rtd-theme>=1.0; extra == "dev"
Requires-Dist: myst-parser>=0.18; extra == "dev"
Requires-Dist: types-setuptools; extra == "dev"
Requires-Dist: types-PyYAML; extra == "dev"
Requires-Dist: pylint>=3.0; extra == "dev"
Requires-Dist: mypy>=1.0; extra == "dev"
Requires-Dist: python-dotenv>=1.1; extra == "dev"
Dynamic: author
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-python

# 🔧 ConfigFlow

**ConfigFlow** is a Python library for managing configuration files with real-time monitoring and event-driven updates.  
Supports **JSON**, **YAML**, and more — with validation and a simple API.

---

## ✨ Features

- **Unified Parsing**: Load JSON, YAML, and other formats.
- **Real-Time Monitoring**: Detect config changes instantly using `watchdog`.
- **Event-Driven**: Register callbacks for config updates.
- **Validation**: Ensure configs match your schema with `pydantic`.

---

## 📦 Installation

```bash
pip install configflow
```

---

## ⚡ Quickstart

```python
from configflow import ConfigFlow

# Initialize with a config file
config = ConfigFlow("settings.yaml")

# Define a schema
schema = {"port": int, "debug": bool}

# Register a callback
@config.on_change
def handle_update(changed_config):
    print(f"Config updated: {changed_config}")

# Load and watch
config.load(schema=schema)
config.watch()

# Keep running (Ctrl+C to stop)
try:
    while True:
        pass
except KeyboardInterrupt:
    config.stop()
```

---

## 📝 Example Config (`settings.yaml`)

```yaml
port: 8080
debug: true
```

---

## 📚 Documentation

Full documentation is available at **[ConfigFlow Docs](https://configflow.readthedocs.io)**.  
(*Replace `#` with your actual docs link once published.*)

---

## 🤝 Contributing

We welcome contributions!  
See [`CONTRIBUTING.md`](CONTRIBUTING.md) for guidelines on adding new features, bug fixes, or parser support.

---

## 📄 License

**MIT License**

> Includes dependencies with compatible licenses:
> - [`watchdog`](https://github.com/gorakhargosh/watchdog) — Apache 2.0  
> - [`PyYAML`](https://pyyaml.org/) — MIT  
> - [`orjson`](https://github.com/ijl/orjson) — Apache 2.0 / MIT  
> - [`pydantic`](https://docs.pydantic.dev/) — MIT  
