# application_settings - version 0.5.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, i.e.,
aim for "zeroconf".
- 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.5.0/Quick_start/)
or dive into the
[full documentation](https://stockwatchdev.github.io/application_settings/0.5.0/).
If you appreciate this library package, then please give us a star on
[Github](https://github.com/StockwatchDev/application_settings).
[//]: # (Change version in header and link to published quick start and full doc)
## 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": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "configuration, settings, dataclass, pydantic, toml",
"author": "Stockwatchdevs",
"author_email": "stockwatchdevs@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a1/2a/752590cf49dbd4997ff3b07f729f8432ee67dc5a547887d629ca2bf1def0/application_settings-0.5.0.tar.gz",
"platform": null,
"description": "# application_settings - version 0.5.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, i.e.,\n aim for \"zeroconf\".\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.5.0/Quick_start/)\nor dive into the\n[full documentation](https://stockwatchdev.github.io/application_settings/0.5.0/).\n\nIf you appreciate this library package, then please give us a star on\n[Github](https://github.com/StockwatchDev/application_settings).\n\n[//]: # (Change version in header and link to published quick start and full doc)\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.5.0",
"project_urls": {
"Changelog": "https://stockwatchdev.github.io/application_settings/stable/CHANGELOG/",
"Documentation": "https://stockwatchdev.github.io/application_settings/stable/",
"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": "a8cc72065009ba4fa19a9f9a3522183fee394db8162f65dc4fda7069f3717c8a",
"md5": "6104dd761137767e694209a2571c25aa",
"sha256": "cef62e89da8c44604b12515c7ac22fb23b9c95e317e87ee93a4273b1b0d084c6"
},
"downloads": -1,
"filename": "application_settings-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6104dd761137767e694209a2571c25aa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 20581,
"upload_time": "2024-10-12T20:28:14",
"upload_time_iso_8601": "2024-10-12T20:28:14.637537Z",
"url": "https://files.pythonhosted.org/packages/a8/cc/72065009ba4fa19a9f9a3522183fee394db8162f65dc4fda7069f3717c8a/application_settings-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a12a752590cf49dbd4997ff3b07f729f8432ee67dc5a547887d629ca2bf1def0",
"md5": "d4d91e398431e840c3cedba767e69e95",
"sha256": "86891a52ac0661d0b6b17b727e902ebcd3beb14ed8d9eb7394def0c427e585ee"
},
"downloads": -1,
"filename": "application_settings-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "d4d91e398431e840c3cedba767e69e95",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 22233,
"upload_time": "2024-10-12T20:28:16",
"upload_time_iso_8601": "2024-10-12T20:28:16.184234Z",
"url": "https://files.pythonhosted.org/packages/a1/2a/752590cf49dbd4997ff3b07f729f8432ee67dc5a547887d629ca2bf1def0/application_settings-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-12 20:28:16",
"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
