https://github.com/protoconf/client-python
https://github.com/protoconf/client-python
Last synced: 17 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/protoconf/client-python
- Owner: protoconf
- License: mit
- Created: 2024-06-25T18:03:33.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-12-06T03:02:51.000Z (4 months ago)
- Last Synced: 2025-12-09T19:19:12.327Z (4 months ago)
- Language: Python
- Size: 147 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
We are still in alpha!
Protoconf Python client
codify configuration, instant delivery
](https://codecov.io/gh/protoconf/client-python)
Table of Contents
- [📍 Overview](#-overview)
- [🧩 Features](#-features)
- [🚀 Getting Started](#-getting-started)
- [🔖 Prerequisites](#-prerequisites)
- [📦 Installation](#-installation)
- [🤝 Contributing](#-contributing)
- [🎗 License](#-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:
```sh
❯ git clone https://github.com/protoconf/client-python
```
2. Navigate to the project directory:
```sh
❯ cd client-python
```
3. Install the required dependencies:
```sh
❯ pip install -r requirements.txt
```
## 🤝 Contributing
Contributions are welcome! Here are several ways you can contribute:
- **[Report Issues](https://github.com/protoconf/client-python/issues)**: Submit bugs found or log feature requests for the `client-python` project.
- **[Submit Pull Requests](https://github.com/protoconf/client-python/blob/main/CONTRIBUTING.md)**: Review open PRs, and submit your own PRs.
- **[Join the Discussions](https://discord.protoconf.sh/)**: Share your insights, provide feedback, or ask questions.
## 🎗 License
This project is protected under the [MIT](https://choosealicense.com/licenses/mit/) License.
For more details, refer to the [LICENSE](https://github.com/protoconf/client-python/blob/main/LICENSE) file.