# application_settings - version 0.3.0
[](https://pypi.python.org/pypi/application-settings)
[](https://github.com/StockwatchDev/application_settings)
[](https://github.com/StockwatchDev/application_settings/actions)
[](https://app.codecov.io/gh/StockwatchDev/application_settings)
[](http://mypy-lang.org/)
[](https://github.com/PyCQA/pylint)
[](https://github.com/psf/black)
[](https://pycqa.github.io/isort/)
[](https://opensource.org/licenses/MIT)
"You write the dataclasses to define parameters for configuration and settings,
application\_settings takes care of the logic."
## What and why
Application\_settings is a package for providing a python application or library with
parameters for configuration and settings. It uses [toml](https://toml.io/en/) or
[json](https://www.json.org/) files that are parsed
into dataclasses. This brings some benefits:
- Minimal work for the developer of the application / library
- Parameters are typed, which allows for improved static code analyses.
- IDEs will provide helpful hints and completion when using the parameters.
- More control over what happens when a file contains mistakes
(by leveraging the power of [pydantic](https://docs.pydantic.dev/)).
- Possibility to specify defaults when no file is found or entries are missing.
- Configuration parameters are read-only (i.e., changed by editing the config file); we
recommend (and support) the use of `toml` for this, which is a human-oriented,
flexible, standardardized and not overly complex format.
- Settings parameters are read-write (i.e., mostly changed via the UI of the
application); we recommend (and support) use `json` for this, an established
standardized machine-oriented format.
Parsing is done once before or during first access and the resulting set of parameters is
stored as a singleton.
Interested? Then have a look at our
[quick start](https://stockwatchdev.github.io/application_settings/0.3.0/docs/Quick_start/).
[//]: # (Change version in header and link to published quick start)
## License
This project is licensed under the terms of the MIT license.
Raw data
{
"_id": null,
"home_page": "https://github.com/StockwatchDev/application_settings",
"name": "application-settings",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "configuration,settings,dataclass,pydantic,toml",
"author": "Stockwatchdevs",
"author_email": "stockwatchdevs@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a3/dd/21a64a71a5e303050cf82108eefd54668c7e9b44fd785261e91f6f3e7bfc/application_settings-0.3.0.tar.gz",
"platform": null,
"description": "# application_settings - version 0.3.0\n\n[](https://pypi.python.org/pypi/application-settings)\n[](https://github.com/StockwatchDev/application_settings)\n[](https://github.com/StockwatchDev/application_settings/actions)\n[](https://app.codecov.io/gh/StockwatchDev/application_settings)\n[](http://mypy-lang.org/)\n[](https://github.com/PyCQA/pylint)\n[](https://github.com/psf/black)\n[](https://pycqa.github.io/isort/)\n[](https://opensource.org/licenses/MIT)\n\n\"You write the dataclasses to define parameters for configuration and settings, \napplication\\_settings takes care of the logic.\"\n\n## What and why\n\nApplication\\_settings is a package for providing a python application or library with\nparameters for configuration and settings. It uses [toml](https://toml.io/en/) or \n[json](https://www.json.org/) files that are parsed\ninto dataclasses. This brings some benefits:\n\n- Minimal work for the developer of the application / library\n- Parameters are typed, which allows for improved static code analyses.\n- IDEs will provide helpful hints and completion when using the parameters.\n- More control over what happens when a file contains mistakes\n (by leveraging the power of [pydantic](https://docs.pydantic.dev/)).\n- Possibility to specify defaults when no file is found or entries are missing.\n- Configuration parameters are read-only (i.e., changed by editing the config file); we\n recommend (and support) the use of `toml` for this, which is a human-oriented,\n flexible, standardardized and not overly complex format.\n- Settings parameters are read-write (i.e., mostly changed via the UI of the\n application); we recommend (and support) use `json` for this, an established\n standardized machine-oriented format.\n\nParsing is done once before or during first access and the resulting set of parameters is\nstored as a singleton.\n\nInterested? Then have a look at our\n[quick start](https://stockwatchdev.github.io/application_settings/0.3.0/docs/Quick_start/).\n\n[//]: # (Change version in header and link to published quick start)\n\n## License\n\nThis project is licensed under the terms of the MIT license.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "For providing a python application with configuration and/or settings",
"version": "0.3.0",
"project_urls": {
"Homepage": "https://github.com/StockwatchDev/application_settings",
"Repository": "https://github.com/StockwatchDev/application_settings"
},
"split_keywords": [
"configuration",
"settings",
"dataclass",
"pydantic",
"toml"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "75d5a414db0e1ff331ab607a812fd498fb6420c5fa7099b30d106c2252a0408f",
"md5": "3f165221bf9658d7525c47ae0c91d502",
"sha256": "08ad5546f0943fc196799a07ff359760befe82cf488e0b60068e416ea8b7416f"
},
"downloads": -1,
"filename": "application_settings-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3f165221bf9658d7525c47ae0c91d502",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 13808,
"upload_time": "2023-06-21T18:17:54",
"upload_time_iso_8601": "2023-06-21T18:17:54.948208Z",
"url": "https://files.pythonhosted.org/packages/75/d5/a414db0e1ff331ab607a812fd498fb6420c5fa7099b30d106c2252a0408f/application_settings-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a3dd21a64a71a5e303050cf82108eefd54668c7e9b44fd785261e91f6f3e7bfc",
"md5": "58c3c48afcc4100574114da3dd99e2ef",
"sha256": "12299d9584e26a7c2ee2de087d7baf6285963dc91f454fb9ecf1ed45ac4b8399"
},
"downloads": -1,
"filename": "application_settings-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "58c3c48afcc4100574114da3dd99e2ef",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 15645,
"upload_time": "2023-06-21T18:17:56",
"upload_time_iso_8601": "2023-06-21T18:17:56.519951Z",
"url": "https://files.pythonhosted.org/packages/a3/dd/21a64a71a5e303050cf82108eefd54668c7e9b44fd785261e91f6f3e7bfc/application_settings-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-21 18:17:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "StockwatchDev",
"github_project": "application_settings",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "application-settings"
}
JSON
