Configuration file management tool
Project description
๐ ConfigBuddy
Manage your configuration files with elegance! ๐จ
โจ Features
- ๐ Multiple format support (YAML, JSON, INI)
- ๐ Smart configuration comparison and visualization
- ๐ Intelligent configuration merging
- โ JSON Schema validation
- ๐ณ Tree-style visualization
๐ Getting Started
Installation
pip install configbuddy
CLI Usage
ConfigBuddy provides a powerful CLI interface for managing your configuration files:
Visualize Configuration
configbuddy visualize config.yaml
Compare Configurations
configbuddy diff base.yaml --compare other.yaml
Merge Configurations
configbuddy merge base.yaml override.yaml -o merged.yaml
Validate Configuration
configbuddy validate config.yaml --schema schema.json
Generate Schema
configbuddy generate-schema config.yaml -o schema.json
Python API Usage
from configbuddy import Config
# Load configuration files
config1 = Config.from_file('config1.yaml')
config2 = Config.from_file('config2.json')
# Visualize configuration
config1.visualize()
# Compare configurations
diff = config1.diff_with(config2)
diff.visualize()
# Merge configurations
merged, conflicts = config1.merge_with(config2)
if conflicts:
print("Merge conflicts detected:", conflicts)
๐ก Examples
Loading and Saving
# Load from YAML
config = Config.from_file('config.yaml')
# Save as JSON
config.save('config.json')
Configuration Comparison
# Compare two configs
diff = config1.diff_with(config2)
# Check differences
print("Added:", diff.added)
print("Removed:", diff.removed)
print("Modified:", diff.modified)
Configuration Merging
# Deep merge (default)
merged, conflicts = config1.merge_with(config2)
# Shallow merge
merged, conflicts = config1.merge_with(config2, strategy='shallow')
Visualization Example
config.yaml
โโโ database
โ โโโ host: "localhost"
โ โโโ port: 5432
โ โโโ credentials
โ โโโ username: "admin"
โ โโโ password: "******"
โโโ logging
โโโ level: "INFO"
โโโ format: "%(asctime)s - %(message)s"
๐ฏ Use Cases
- ๐ Manage dev/staging/prod configurations
- ๐ค Share and merge team configurations
- ๐ Track configuration changes
- ๐ Version control experiment settings (ML/Data Science)
๐ฃ๏ธ Roadmap
- CLI interface
- PyPi Upload
- Comment preservation
- XML/TOML support
- Web dashboard (visualization/comparison)
๐ค Contributing
Bug reports, feature suggestions, and pull requests are welcome! See CONTRIBUTING.md for details.
๐ License
MIT License - see LICENSE for details.
๐ Star History
Made with โค๏ธ by Harim Kang
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file configbuddy-0.1.0.tar.gz.
File metadata
- Download URL: configbuddy-0.1.0.tar.gz
- Upload date:
- Size: 1.7 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.10.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6ed7d6b4128297217c7c795ff3a28c1dd6bffa055104e30c17c9633688718a26
|
|
| MD5 |
aa31414d1447966ac082111fab0cd3fa
|
|
| BLAKE2b-256 |
76aebcf0bd9ac7e936b2437e3240aef7191686ea10a742bac0ccb240896d91b5
|
File details
Details for the file configbuddy-0.1.0-py3-none-any.whl.
File metadata
- Download URL: configbuddy-0.1.0-py3-none-any.whl
- Upload date:
- Size: 16.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.10.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c4edf0fbe3fbd8698d1f1d3fa0a729a8b547976c24b39bfbcda45703fdf7c8f4
|
|
| MD5 |
61b1998cbae320a18aa86c081a5b5601
|
|
| BLAKE2b-256 |
2588fd6b9263d5307235307df1644a1971b20e33cf45fbe7dbf3741ea2f7eae5
|