.. .. image:: https://readthedocs.org/projects/config_patterns/badge/?version=latest
:target: https://config_patterns.readthedocs.io/index.html
:alt: Documentation Status
.. image:: https://github.com/MacHu-GWU/config_patterns-project/actions/workflows/main.yml/badge.svg
:target: https://github.com/MacHu-GWU/config_patterns-project/actions?query=workflow:CI
.. image:: https://codecov.io/gh/MacHu-GWU/config_patterns-project/branch/main/graph/badge.svg
:target: https://codecov.io/gh/MacHu-GWU/config_patterns-project
.. image:: https://img.shields.io/pypi/v/config_patterns.svg
:target: https://pypi.python.org/pypi/config_patterns
.. image:: https://img.shields.io/pypi/l/config_patterns.svg
:target: https://pypi.python.org/pypi/config_patterns
.. image:: https://img.shields.io/pypi/pyversions/config_patterns.svg
:target: https://pypi.python.org/pypi/config_patterns
.. image:: https://img.shields.io/pypi/dm/config_patterns.svg
:target: https://pypi.python.org/pypi/config_patterns
.. image:: https://img.shields.io/badge/release_history!--None.svg?style=social
:target: https://github.com/MacHu-GWU/config_patterns-project/blob/main/release-history.rst
.. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social
:target: https://github.com/MacHu-GWU/config_patterns-project
------
.. .. image:: https://img.shields.io/badge/Link-Document-blue.svg
:target: https://config_patterns.readthedocs.io/index.html
.. .. image:: https://img.shields.io/badge/Link-API-blue.svg
:target: https://config_patterns.readthedocs.io/py-modindex.html
.. .. image:: https://img.shields.io/badge/Link-Source_Code-blue.svg
:target: https://config_patterns.readthedocs.io/py-modindex.html
.. image:: https://img.shields.io/badge/Link-Install-blue.svg
:target: `install`_
.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg
:target: https://github.com/MacHu-GWU/config_patterns-project
.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg
:target: https://github.com/MacHu-GWU/config_patterns-project/issues
.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg
:target: https://github.com/MacHu-GWU/config_patterns-project/issues
.. image:: https://img.shields.io/badge/Link-Download-blue.svg
:target: https://pypi.org/pypi/config_patterns#files
Welcome to ``config_patterns`` Documentation
==============================================================================
.. image:: https://github.com/MacHu-GWU/config_patterns-project/assets/6800411/0cfdeee0-6740-4522-b2e9-a17e51facba9
``config_patterns`` is a Python library that brings config management best practices for production-ready application.
1. `Hierarchy Json Pattern for Config Management <https://github.com/MacHu-GWU/config_patterns-project/blob/main/example/separate_and_merge_non_sesitive_and_sensitive_data_example.ipynb>`_: allows you to define a hierarchy structure of your config data model, and inherit global config values if a specific config value is not defined.
2. `Separate and Merge Non-Sensitive Data and Secret Data <https://github.com/MacHu-GWU/config_patterns-project/blob/main/example/separate_and_merge_non_sesitive_and_sensitive_data_example.ipynb>`_: allows you to manage non-sensitive config data and sensitive config data separately and merge them together.
3. `Multi Environment Json <https://github.com/MacHu-GWU/config_patterns-project/blob/main/example/multi_env_json/multi_environment_config.ipynb>`_: allows you to manage configs for multi-environment deployment application.
4. `Multi Environment Config Management - SSM Backend <https://github.com/MacHu-GWU/config_patterns-project/blob/main/example/multi_env_json/multi_environment_config_with_ssm_backend.ipynb>`_: a production ready solution using AWS Parameter Store as the backend for multi-environment config management.
5. `Multi Environment Config Management - S3 Backend <https://github.com/MacHu-GWU/config_patterns-project/blob/main/example/multi_env_json/multi_environment_config_with_s3_backend.ipynb>`_: a production ready solution using AWS S3 as the backend for multi-environment config management.
.. _install:
Install
------------------------------------------------------------------------------
``config_patterns`` is released on PyPI, so all you need is:
.. code-block:: console
$ pip install config_patterns
To upgrade to latest version:
.. code-block:: console
$ pip install --upgrade config_patterns
Raw data
{
"_id": null,
"home_page": "https://github.com/MacHu-GWU/config_patterns-project",
"name": "config-patterns",
"maintainer": "Unknown",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": "Sanhe Hu",
"author_email": "husanhe@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c8/4b/c72b91dce9a2fb748e1d744be8e281291a41f71d14802afb124ae6dcb6cc/config_patterns-1.0.7.tar.gz",
"platform": "Windows",
"description": "\n.. .. image:: https://readthedocs.org/projects/config_patterns/badge/?version=latest\n :target: https://config_patterns.readthedocs.io/index.html\n :alt: Documentation Status\n\n.. image:: https://github.com/MacHu-GWU/config_patterns-project/actions/workflows/main.yml/badge.svg\n :target: https://github.com/MacHu-GWU/config_patterns-project/actions?query=workflow:CI\n\n.. image:: https://codecov.io/gh/MacHu-GWU/config_patterns-project/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/MacHu-GWU/config_patterns-project\n\n.. image:: https://img.shields.io/pypi/v/config_patterns.svg\n :target: https://pypi.python.org/pypi/config_patterns\n\n.. image:: https://img.shields.io/pypi/l/config_patterns.svg\n :target: https://pypi.python.org/pypi/config_patterns\n\n.. image:: https://img.shields.io/pypi/pyversions/config_patterns.svg\n :target: https://pypi.python.org/pypi/config_patterns\n\n.. image:: https://img.shields.io/pypi/dm/config_patterns.svg\n :target: https://pypi.python.org/pypi/config_patterns\n\n.. image:: https://img.shields.io/badge/release_history!--None.svg?style=social\n :target: https://github.com/MacHu-GWU/config_patterns-project/blob/main/release-history.rst\n\n.. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social\n :target: https://github.com/MacHu-GWU/config_patterns-project\n\n------\n\n.. .. image:: https://img.shields.io/badge/Link-Document-blue.svg\n :target: https://config_patterns.readthedocs.io/index.html\n\n.. .. image:: https://img.shields.io/badge/Link-API-blue.svg\n :target: https://config_patterns.readthedocs.io/py-modindex.html\n\n.. .. image:: https://img.shields.io/badge/Link-Source_Code-blue.svg\n :target: https://config_patterns.readthedocs.io/py-modindex.html\n\n.. image:: https://img.shields.io/badge/Link-Install-blue.svg\n :target: `install`_\n\n.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg\n :target: https://github.com/MacHu-GWU/config_patterns-project\n\n.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg\n :target: https://github.com/MacHu-GWU/config_patterns-project/issues\n\n.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg\n :target: https://github.com/MacHu-GWU/config_patterns-project/issues\n\n.. image:: https://img.shields.io/badge/Link-Download-blue.svg\n :target: https://pypi.org/pypi/config_patterns#files\n\n\nWelcome to ``config_patterns`` Documentation\n==============================================================================\n.. image:: https://github.com/MacHu-GWU/config_patterns-project/assets/6800411/0cfdeee0-6740-4522-b2e9-a17e51facba9\n\n``config_patterns`` is a Python library that brings config management best practices for production-ready application.\n\n1. `Hierarchy Json Pattern for Config Management <https://github.com/MacHu-GWU/config_patterns-project/blob/main/example/separate_and_merge_non_sesitive_and_sensitive_data_example.ipynb>`_: allows you to define a hierarchy structure of your config data model, and inherit global config values if a specific config value is not defined.\n2. `Separate and Merge Non-Sensitive Data and Secret Data <https://github.com/MacHu-GWU/config_patterns-project/blob/main/example/separate_and_merge_non_sesitive_and_sensitive_data_example.ipynb>`_: allows you to manage non-sensitive config data and sensitive config data separately and merge them together.\n3. `Multi Environment Json <https://github.com/MacHu-GWU/config_patterns-project/blob/main/example/multi_env_json/multi_environment_config.ipynb>`_: allows you to manage configs for multi-environment deployment application.\n4. `Multi Environment Config Management - SSM Backend <https://github.com/MacHu-GWU/config_patterns-project/blob/main/example/multi_env_json/multi_environment_config_with_ssm_backend.ipynb>`_: a production ready solution using AWS Parameter Store as the backend for multi-environment config management.\n5. `Multi Environment Config Management - S3 Backend <https://github.com/MacHu-GWU/config_patterns-project/blob/main/example/multi_env_json/multi_environment_config_with_s3_backend.ipynb>`_: a production ready solution using AWS S3 as the backend for multi-environment config management.\n\n.. _install:\n\nInstall\n------------------------------------------------------------------------------\n\n``config_patterns`` is released on PyPI, so all you need is:\n\n.. code-block:: console\n\n $ pip install config_patterns\n\nTo upgrade to latest version:\n\n.. code-block:: console\n\n $ pip install --upgrade config_patterns\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Brings config management best practices for production-ready application.",
"version": "1.0.7",
"project_urls": {
"Download": "https://pypi.python.org/pypi/config_patterns/1.0.7#downloads",
"Homepage": "https://github.com/MacHu-GWU/config_patterns-project"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6488539fb45529334bfecde725b464f98c6001712221df18580d82c82cc088ba",
"md5": "e7e32f408ae0dd069f7c90ef9b925ba2",
"sha256": "d4e5c46c3f82674c2d392b4e09b1c9c4d8002ee0d4323b373caf19d62725f7f3"
},
"downloads": -1,
"filename": "config_patterns-1.0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e7e32f408ae0dd069f7c90ef9b925ba2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 43569,
"upload_time": "2024-06-16T21:16:59",
"upload_time_iso_8601": "2024-06-16T21:16:59.342272Z",
"url": "https://files.pythonhosted.org/packages/64/88/539fb45529334bfecde725b464f98c6001712221df18580d82c82cc088ba/config_patterns-1.0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c84bc72b91dce9a2fb748e1d744be8e281291a41f71d14802afb124ae6dcb6cc",
"md5": "7fea93da2ed6867c34cc246e9e036563",
"sha256": "b4f24aa187f0ccc6e7414a370c0c0aec14cb891819684775255751b50bc7e3a8"
},
"downloads": -1,
"filename": "config_patterns-1.0.7.tar.gz",
"has_sig": false,
"md5_digest": "7fea93da2ed6867c34cc246e9e036563",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 41821,
"upload_time": "2024-06-16T21:17:01",
"upload_time_iso_8601": "2024-06-16T21:17:01.283000Z",
"url": "https://files.pythonhosted.org/packages/c8/4b/c72b91dce9a2fb748e1d744be8e281291a41f71d14802afb124ae6dcb6cc/config_patterns-1.0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-16 21:17:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MacHu-GWU",
"github_project": "config_patterns-project",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [
{
"name": "cached-property",
"specs": [
[
">=",
"1.5.2"
]
]
},
{
"name": "typing-extensions",
"specs": []
},
{
"name": "vislog",
"specs": [
[
">=",
"0.1.2"
],
[
"<",
"1.0.0"
]
]
}
],
"tox": true,
"lcname": "config-patterns"
}
JSON
