| Name | allconf JSON |
| Version |
4.0.0
JSON |
| download |
| home_page | None |
| Summary | Configuration file reader with some nifty bells and whistles added |
| upload_time | 2024-11-15 13:26:56 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | MIT License Copyright (c) 2024 Thordur Matthiasson Copyright (c) 2019-2024 CCP Games 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. |
| keywords |
config
configuration
json
yaml
tools
utils
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# AllConf the All-Knowing Config Reader
Generic Configuration file reader/parser with a bunch of nifty extra
features, most notably:
- File Inclusion & Extension
- Internal variable reference parsing
- Nested fault-tolerant fetching of non-existing values
- Environment variable embedding
- On-demand external secret credential embedding _(untested in this new fork thus far)_
- Python script result embedding
- Single-file rendering of parsed config file (via CLI)
- Python dataclass stub generation (via CLI)
- JSON, YAML & custom support
- ...and more
## Note
This was forked from the [`alviss`](https://github.com/ccpgames/allconf) package
in order to continue development and support.
## The TL;DR...
Given this `my_cfg.yaml` config file example:
```yaml
app:
name: MyApp
environment: dev
log_level: INFO
```
This is how you load and use it with `allconf`:
```python
from allconf import quickloader
cfg = quickloader.autoload('my_cfg.yaml')
assert cfg.app.name == 'MyApp'
assert cfg.app.environment == 'dev'
assert cfg.app.log_level == 'INFO'
```
And that's basically it really!
Read on for description of more features in order of "quality of life" impact
for you as a programmer _(as gauged by myself)_ and it goes more or less like this:
1. File Inclusion & Extension
2. Internal variable reference parsing
3. Nested fault-tolerant fetching of non-existing values
4. Environment variable embedding
5. On-demand external secret credential embedding _(untested in this new fork thus far)_
6. Python script result embedding
7. Single-file rendering of parsed config file (via CLI)
8. Python dataclass stub generation (via CLI)
9. JSON, YAML & custom support
...I'll document this later!
Check out the (`_OLD_README.md`)[_OLD_README.md] file for the old documentation (which may or may not be up to date)!
Raw data
{
"_id": null,
"home_page": null,
"name": "allconf",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "config, configuration, json, yaml, tools, utils",
"author": null,
"author_email": "Thordur Matthiasson <doddi79@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/49/8d/363a1eba7c39a424ae11d3505d6937c3c1937c59245ab709b4f6baae0b23/allconf-4.0.0.tar.gz",
"platform": null,
"description": "# AllConf the All-Knowing Config Reader\n\nGeneric Configuration file reader/parser with a bunch of nifty extra \nfeatures, most notably:\n\n- File Inclusion & Extension\n- Internal variable reference parsing\n- Nested fault-tolerant fetching of non-existing values\n- Environment variable embedding\n- On-demand external secret credential embedding _(untested in this new fork thus far)_\n- Python script result embedding\n- Single-file rendering of parsed config file (via CLI)\n- Python dataclass stub generation (via CLI)\n- JSON, YAML & custom support\n- ...and more\n\n\n## Note\n\nThis was forked from the [`alviss`](https://github.com/ccpgames/allconf) package\nin order to continue development and support. \n\n## The TL;DR...\n\nGiven this `my_cfg.yaml` config file example:\n\n```yaml\napp:\n name: MyApp\n environment: dev\n log_level: INFO\n```\n\nThis is how you load and use it with `allconf`:\n\n```python\nfrom allconf import quickloader\n\ncfg = quickloader.autoload('my_cfg.yaml')\n\nassert cfg.app.name == 'MyApp'\nassert cfg.app.environment == 'dev'\nassert cfg.app.log_level == 'INFO'\n```\n\nAnd that's basically it really!\n\nRead on for description of more features in order of \"quality of life\" impact \nfor you as a programmer _(as gauged by myself)_ and it goes more or less like this:\n\n1. File Inclusion & Extension\n2. Internal variable reference parsing\n3. Nested fault-tolerant fetching of non-existing values\n4. Environment variable embedding\n5. On-demand external secret credential embedding _(untested in this new fork thus far)_\n6. Python script result embedding\n7. Single-file rendering of parsed config file (via CLI)\n8. Python dataclass stub generation (via CLI)\n9. JSON, YAML & custom support\n\n...I'll document this later!\n\nCheck out the (`_OLD_README.md`)[_OLD_README.md] file for the old documentation (which may or may not be up to date)!\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Thordur Matthiasson Copyright (c) 2019-2024 CCP Games 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. ",
"summary": "Configuration file reader with some nifty bells and whistles added",
"version": "4.0.0",
"project_urls": {
"Changelog": "https://github.com/doddi79/allconf/blob/main/CHANGELOG.md",
"Documentation": "https://github.com/doddi79/allconf/blob/main/README.md",
"Homepage": "https://github.com/doddi79/allconf",
"Issues": "https://github.com/doddi79/allconf/issues",
"Repository": "https://github.com/doddi79/allconf.git"
},
"split_keywords": [
"config",
" configuration",
" json",
" yaml",
" tools",
" utils"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9da2ded042b6913af9fce20dd7d66c708c0c04c11d7cda540b31f0e4e0e5c136",
"md5": "09979611367b588eebe53a60d7b8c0b6",
"sha256": "dc79cca8670ead384e60e5e5a74fecb416ad066f1cae160eed079634c0a019f0"
},
"downloads": -1,
"filename": "allconf-4.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "09979611367b588eebe53a60d7b8c0b6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 25844,
"upload_time": "2024-11-15T13:26:55",
"upload_time_iso_8601": "2024-11-15T13:26:55.181349Z",
"url": "https://files.pythonhosted.org/packages/9d/a2/ded042b6913af9fce20dd7d66c708c0c04c11d7cda540b31f0e4e0e5c136/allconf-4.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "498d363a1eba7c39a424ae11d3505d6937c3c1937c59245ab709b4f6baae0b23",
"md5": "8b19a7df6c1864271ff8cbe9aae7e601",
"sha256": "8102ba7f96a3a87eb137d9a7b5cbccd3a82c92db36cd893c0193872a367c8f82"
},
"downloads": -1,
"filename": "allconf-4.0.0.tar.gz",
"has_sig": false,
"md5_digest": "8b19a7df6c1864271ff8cbe9aae7e601",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 19760,
"upload_time": "2024-11-15T13:26:56",
"upload_time_iso_8601": "2024-11-15T13:26:56.257406Z",
"url": "https://files.pythonhosted.org/packages/49/8d/363a1eba7c39a424ae11d3505d6937c3c1937c59245ab709b4f6baae0b23/allconf-4.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-15 13:26:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "doddi79",
"github_project": "allconf",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "allconf"
}
