# Concoction
Concoction is a simple configuration injection library that allows you to easily inject configuration values into your
Python applications. It supports both `pydantic` and `dataclasses` for defining configuration models. Unlike traditional
configuration management tools, Concoction does not parse or layer configurations; it only works with a dictionary
object as an input.
## Inspiration
Concoction is inspired by the `@ConfigurationProperties` and `@Value` annotations from Spring Boot. These annotations
allow for easy injection of configuration properties into Java applications, and Concoction aims to provide a similar
experience for Python developers.
## Key Features
- **Flexibility with Plain Dictionaries**: Simple and flexible configuration management using plain dictionaries.
- **Injecting Whole Configuration Blocks**: Inject entire configuration blocks for modular and decoupled settings.
- **Injecting Individual Fields**: Granular control with the ability to inject specific configuration fields.
## Installation
To install Concoction, run the following command:
```bash
pip install concoction
```
## Usage
Here is an example of `config.yaml` file:
```yaml
app:
service:
host: 0.0.0.0
port: 8000
```
and injecting `service` section into our config
```python
import yaml # pip install pyyaml
from pydantic import BaseModel
from concoction import Configuration, set_global_config
# define config with injection
@Configuration("app.service")
class ServiceConfig(BaseModel):
host: str
port: int
# Load configuration from a YAML file
with open("config.yaml") as f:
config = yaml.safe_load(f)
set_global_config(config)
# Create an instance of the configuration model
app_config = ServiceConfig()
```
or field-wise
```python
from concoction.values.pydantic import Value
class ServiceConfig(BaseModel):
host: str = Value("app.service.host")
port: int = Value("app.service.port")
```
## Contributing
Contributions are welcome! Please open an issue or submit a pull request on GitHub.
Raw data
{
"_id": null,
"home_page": "https://github.com/soapun/concoction",
"name": "concoction",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.8",
"maintainer_email": null,
"keywords": "python, config, configuration, settings, injection, injector, configuration-management",
"author": "soapun",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/6c/84/7956c0651274b660f75957c60b07e4befed239713b6056245c4f1e5738fe/concoction-0.1.3.tar.gz",
"platform": null,
"description": "# Concoction\n\nConcoction is a simple configuration injection library that allows you to easily inject configuration values into your\nPython applications. It supports both `pydantic` and `dataclasses` for defining configuration models. Unlike traditional\nconfiguration management tools, Concoction does not parse or layer configurations; it only works with a dictionary\nobject as an input.\n\n## Inspiration\n\nConcoction is inspired by the `@ConfigurationProperties` and `@Value` annotations from Spring Boot. These annotations\nallow for easy injection of configuration properties into Java applications, and Concoction aims to provide a similar\nexperience for Python developers.\n\n## Key Features\n\n- **Flexibility with Plain Dictionaries**: Simple and flexible configuration management using plain dictionaries.\n- **Injecting Whole Configuration Blocks**: Inject entire configuration blocks for modular and decoupled settings.\n- **Injecting Individual Fields**: Granular control with the ability to inject specific configuration fields.\n\n## Installation\n\nTo install Concoction, run the following command:\n\n```bash\npip install concoction\n```\n\n## Usage\n\nHere is an example of `config.yaml` file:\n\n```yaml\napp:\n service:\n host: 0.0.0.0\n port: 8000\n```\n\nand injecting `service` section into our config\n\n```python\nimport yaml # pip install pyyaml\nfrom pydantic import BaseModel\nfrom concoction import Configuration, set_global_config\n\n\n# define config with injection\n\n@Configuration(\"app.service\")\nclass ServiceConfig(BaseModel):\n host: str\n port: int\n\n\n# Load configuration from a YAML file\nwith open(\"config.yaml\") as f:\n config = yaml.safe_load(f)\n\nset_global_config(config)\n\n# Create an instance of the configuration model\napp_config = ServiceConfig()\n```\n\nor field-wise\n\n```python\nfrom concoction.values.pydantic import Value\n\n\nclass ServiceConfig(BaseModel):\n host: str = Value(\"app.service.host\")\n port: int = Value(\"app.service.port\")\n```\n\n## Contributing\n\nContributions are welcome! Please open an issue or submit a pull request on GitHub.",
"bugtrack_url": null,
"license": "MIT",
"summary": "Library to inject configurations",
"version": "0.1.3",
"project_urls": {
"Homepage": "https://github.com/soapun/concoction",
"Repository": "https://github.com/soapun/concoction"
},
"split_keywords": [
"python",
" config",
" configuration",
" settings",
" injection",
" injector",
" configuration-management"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3f2c8ac7385b6551d453bd2016704c3e99826b91f3da8220bdb91e900a1d0f45",
"md5": "946c8a14774c4a125a5e27727001e44e",
"sha256": "6121b32ad812b5f039d44f82371edd36169d854c6ad36a7bc8db8a025f014a13"
},
"downloads": -1,
"filename": "concoction-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "946c8a14774c4a125a5e27727001e44e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 4875,
"upload_time": "2024-08-24T14:14:17",
"upload_time_iso_8601": "2024-08-24T14:14:17.648965Z",
"url": "https://files.pythonhosted.org/packages/3f/2c/8ac7385b6551d453bd2016704c3e99826b91f3da8220bdb91e900a1d0f45/concoction-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6c847956c0651274b660f75957c60b07e4befed239713b6056245c4f1e5738fe",
"md5": "0c8c6f1e5d5c268e2686064009556530",
"sha256": "55a8ef81e14859749c192d1daec94b967cc6cc325c5177b886cf4c70c4bf430d"
},
"downloads": -1,
"filename": "concoction-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "0c8c6f1e5d5c268e2686064009556530",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 3670,
"upload_time": "2024-08-24T14:14:18",
"upload_time_iso_8601": "2024-08-24T14:14:18.894916Z",
"url": "https://files.pythonhosted.org/packages/6c/84/7956c0651274b660f75957c60b07e4befed239713b6056245c4f1e5738fe/concoction-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-24 14:14:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "soapun",
"github_project": "concoction",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "concoction"
}
JSON
