# A convenient utility for managing configurations.
## Installation
```bash
python3 -m pip install config-kit
```
## Usage
### Use in Python
```python
from config_kit.core import ConfigKit
# Intialize a ConfigKit instance
config = ConfigKit(config_file='config.ini', section='common')
# Set configuration items
config.username = 'admin'
config.password = '123456'
# Remove configuration items
del config.username
# Save configuration items
config.save()
# Retrieve configuration items
print(config.username)
print(config.password)
# Use a context manager to automatically save changes
with ConfigKit(config_file='config.ini') as config:
config.host = 'localhost'
config.port = 8080
```
### Use in Shell
```bash
config-kit --help
config-kit -c config.ini -s common sub-command [arguments]
# Set configuration items
config-kit set username admin
config-kit set password 123456
# Remove configuration items
config-kit remove username
# Retrieve configuration items
config-kit get username
config-kit get password
```
## Configuration File Format
The configuration file is in the INI format, with sections and key-value pairs. For example:
```ini
[common]
username = admin
password = 123456
[database]
host = localhost
port = 3306
```
Raw data
{
"_id": null,
"home_page": "https://github.com/suqingdong/config_kit",
"name": "config-kit",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "suqingdong",
"author_email": "suqingdong1114@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/49/6f/29eeaf9893301c7a48baa133f48658eee5a975a1121ad3bb936149bc4cfe/config_kit-1.0.0.tar.gz",
"platform": null,
"description": "# A convenient utility for managing configurations.\n\n## Installation\n\n```bash\npython3 -m pip install config-kit\n```\n\n## Usage\n\n### Use in Python\n\n```python\nfrom config_kit.core import ConfigKit\n\n# Intialize a ConfigKit instance\nconfig = ConfigKit(config_file='config.ini', section='common')\n\n# Set configuration items\nconfig.username = 'admin'\nconfig.password = '123456'\n\n# Remove configuration items\ndel config.username\n\n# Save configuration items\nconfig.save()\n\n# Retrieve configuration items\nprint(config.username)\nprint(config.password)\n\n\n# Use a context manager to automatically save changes\nwith ConfigKit(config_file='config.ini') as config:\n config.host = 'localhost'\n config.port = 8080\n```\n\n### Use in Shell\n\n```bash\nconfig-kit --help\n\nconfig-kit -c config.ini -s common sub-command [arguments]\n\n# Set configuration items\nconfig-kit set username admin\nconfig-kit set password 123456\n\n# Remove configuration items\nconfig-kit remove username\n\n# Retrieve configuration items\nconfig-kit get username\nconfig-kit get password\n```\n\n## Configuration File Format\n\nThe configuration file is in the INI format, with sections and key-value pairs. For example:\n\n```ini\n[common]\nusername = admin\npassword = 123456\n\n[database]\nhost = localhost\nport = 3306\n```\n\n\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "A convenient utility for managing configurations.",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/suqingdong/config_kit"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "10f95b50d1d0a555f2182e09c2f8564426d516051f2ca748bc3bc9d0bcde6938",
"md5": "99bd6c8894d82e7eceb446b5525fabff",
"sha256": "dc27d1cea39373bafcd2e2c108a564f75e37ca4963045c9bf2e0803d285dbbdd"
},
"downloads": -1,
"filename": "config_kit-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "99bd6c8894d82e7eceb446b5525fabff",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4767,
"upload_time": "2024-11-21T07:09:43",
"upload_time_iso_8601": "2024-11-21T07:09:43.802182Z",
"url": "https://files.pythonhosted.org/packages/10/f9/5b50d1d0a555f2182e09c2f8564426d516051f2ca748bc3bc9d0bcde6938/config_kit-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "496f29eeaf9893301c7a48baa133f48658eee5a975a1121ad3bb936149bc4cfe",
"md5": "438ff79e6dd320415b9ccd107615d93f",
"sha256": "421f1d46fa2b969b8ca6684ba3bbc1af331086f02b3f3d3116eaffbe1fe3c3c8"
},
"downloads": -1,
"filename": "config_kit-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "438ff79e6dd320415b9ccd107615d93f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4000,
"upload_time": "2024-11-21T07:09:45",
"upload_time_iso_8601": "2024-11-21T07:09:45.784050Z",
"url": "https://files.pythonhosted.org/packages/49/6f/29eeaf9893301c7a48baa133f48658eee5a975a1121ad3bb936149bc4cfe/config_kit-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-21 07:09:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "suqingdong",
"github_project": "config_kit",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "click",
"specs": []
},
{
"name": "loguru",
"specs": []
}
],
"lcname": "config-kit"
}
JSON
