https://github.com/machu-gwu/config_patterns-project
Brings config management best practices for production-ready application.
https://github.com/machu-gwu/config_patterns-project
aws aws-parameter-store aws-s3 config-management python
Last synced: 7 months ago
JSON representation
Brings config management best practices for production-ready application.
- Host: GitHub
- URL: https://github.com/machu-gwu/config_patterns-project
- Owner: MacHu-GWU
- License: mit
- Created: 2023-02-04T16:34:49.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-16T21:18:38.000Z (over 1 year ago)
- Last Synced: 2025-02-20T11:18:13.034Z (8 months ago)
- Topics: aws, aws-parameter-store, aws-s3, config-management, python
- Language: Jupyter Notebook
- Homepage:
- Size: 325 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- License: LICENSE.txt
- Authors: AUTHORS.rst
Awesome Lists containing this project
README
.. .. 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 `_: 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 `_: allows you to manage non-sensitive config data and sensitive config data separately and merge them together.
3. `Multi Environment Json `_: allows you to manage configs for multi-environment deployment application.
4. `Multi Environment Config Management - SSM Backend `_: a production ready solution using AWS Parameter Store as the backend for multi-environment config management.
5. `Multi Environment Config Management - S3 Backend `_: 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