Skip to main content
Documentation Status https://github.com/MacHu-GWU/aws_config-project/actions/workflows/main.yml/badge.svg https://codecov.io/gh/MacHu-GWU/aws_config-project/branch/main/graph/badge.svg https://img.shields.io/pypi/v/aws-config.svg https://img.shields.io/pypi/l/aws-config.svg https://img.shields.io/pypi/pyversions/aws-config.svg https://img.shields.io/badge/✍️_Release_History!--None.svg?style=social&logo=github https://img.shields.io/badge/⭐_Star_me_on_GitHub!--None.svg?style=social&logo=github
https://img.shields.io/badge/Link-API-blue.svg https://img.shields.io/badge/Link-Install-blue.svg https://img.shields.io/badge/Link-GitHub-blue.svg https://img.shields.io/badge/Link-Submit_Issue-blue.svg https://img.shields.io/badge/Link-Request_Feature-blue.svg https://img.shields.io/badge/Link-Download-blue.svg

Welcome to aws_config Documentation

https://aws-config.readthedocs.io/en/latest/_static/aws_config-logo.png

aws_config is a well-defined configuration management framework for multi-environment applications that uses AWS services as the configuration backend. This library is built from years of Amazon best practices for managing application configurations at scale.

The framework provides hierarchical configuration management with inheritance, automatic parameter generation for different environments (dev, test, prod), and seamless integration with AWS SSM Parameter Store and S3. It eliminates configuration drift between environments while maintaining security through proper secret management.

Key benefits include type-safe configuration classes, environment-specific parameter validation, automated deployment to AWS backend services, and built-in configuration inheritance that reduces duplication across environments.

from aws_config import BaseConfig, BaseEnv, BaseEnvNameEnum
from pydantic import Field

class EnvNameEnum(BaseEnvNameEnum):
    dev = "dev"
    prod = "prod"

class Env(BaseEnv):
    username: str = Field()
    password: str = Field()

class Config(BaseConfig[Env, EnvNameEnum]):
    pass

config = Config(
    data={
        "_defaults": {
            "*.project_name": "my_app",
        }
        "dev": {
            "username": "alice"
        },
        "prod": {
            "username": "bob"
        }
    },
    secret_data={
        "dev": {
            "username": "alice-pwd"
        },
        "prod": {
            "username": "bob-pwd"
        }
    },
    EnvClass=Env,
    EnvNameEnumClass=EnvNameEnum,
)
env = config.get_env(EnvNameEnum.dev)

Install

aws_config is released on PyPI, so all you need is to:

$ pip install aws-config

To upgrade to latest version:

$ pip install --upgrade aws-config

Metadata

Release files for aws-config 0.1.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aws-config 0.1.5
File Size Uploaded
aws_config-0.1.5.tar.gz 35.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for aws-config 0.1.5
File Interpreter ABI Platform
aws_config-0.1.5-py3-none-any.whl Python 3 none any Details

Total release size: 73.2 kB

Release files / aws_config-0.1.5.tar.gz

Download URL aws_config-0.1.5.tar.gz
Size 35.1 kB
Tags Source
SHA-256 checksum
How to use checksums
99f8219e1a1c5bb581c9755e78e5f4a7d15c044d5973f1cd18638ab8cb6a64d2
BLAKE2b-256 checksum
How to use checksums
8219dbe56718a040568f88a993b082ab8d0961d8c0b699b3cfa561d244a46cda
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.8

Release files / aws_config-0.1.5-py3-none-any.whl

Download URL aws_config-0.1.5-py3-none-any.whl
Size 38.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9ca2a49c13f80cc02ed45fa4b686cf223159b9028656c4ca3f502ec129227304
BLAKE2b-256 checksum
How to use checksums
8b2c9085110793d732687aade28cb90a76bc7bfa60330f1bce24c3e0754f7507
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.8

Release history Release notifications | RSS feed

This release

0.1.5 This release

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page