README.md

We are still in alpha!

Protoconf Python client

codify configuration, instant delivery

Table of Contents

• 📍 Overview
• 🧩 Features
• 🚀 Getting Started
  • 🔖 Prerequisites
  • 📦 Installation
• 🤝 Contributing
• 🎗 License

---

📍 Overview

protoconfloader is a Python library that provides a flexible and robust configuration management solution.
It supports loading configuration from files, watching for file changes, and subscribing to configuration updates from a Protoconf server.

---

🧩 Features

• Load configuration from files
• Watch configuration files for changes
• Subscribe to configuration updates from a Protoconf server
• Hot Reload of configuration changes
• Thread-safe access to configuration values

🚀 Getting Started

🔖 Prerequisites

Python: version 3.11

📦 Installation

Using pip

pip install protoconfloader

Build the project from source:

1. Clone the client-python repository:

❯ git clone https://github.com/protoconf/client-python

2. Navigate to the project directory:

❯ cd client-python

3. Install the required dependencies:

❯ pip install -r requirements.txt

🤝 Contributing

Contributions are welcome! Here are several ways you can contribute:

• Report Issues: Submit bugs found or log feature requests for the client-python project.
• Submit Pull Requests: Review open PRs, and submit your own PRs.
• Join the Discussions: Share your insights, provide feedback, or ask questions.

🎗 License

This project is protected under the MIT License.
For more details, refer to the LICENSE file.