Skip to main content

The Settings and Configuration on ideal practices for app development.

Project description

ConfigAlchemy

https://img.shields.io/pypi/v/configalchemy.svg CI Test Status Documentation Status https://img.shields.io/pypi/pyversions/configalchemy.svg https://codecov.io/gh/GuangTianLi/configalchemy/branch/master/graph/badge.svg https://img.shields.io/badge/code%20style-black-000000.svg

The Settings and Configuration on ideal practices for app development and package building.

Installation

$ pipenv install configalchemy
✨🍰✨

Only Python 3.6+ is supported.

Example

from configalchemy import BaseConfig

class DefaultConfig(BaseConfig):
    NAME = "test"

config = DefaultConfig()
config.NAME
>>> 'test'

Features

  • Base on The Twelve-Factor App Configuration.

  • Configurable dynamic configurator

  • Configuration-Oriented Development

    • Define default config value and its type which is used in your project

    • Use class to support inheritance to explicitly define configurable config

  • Override config value from multiple source with priority supported

    • Callable function return value

    • File (default: json)

    • Environment Variables

  • Proper Typecast before overriding

  • Generic Config Type Support by custom typecast

  • Lazy and Proxy Object Support.

  • Extension

TODO

  • IOC - Injector, Singleton

History

0.5.* (2020-12)

  • Support SingletonMetaClass

  • Remove unpack feature in BaseConfig by removing Mapping Class

  • Support nested config for large modular purpose

  • Support local object

  • Support generic pool object

  • Support Dot Notation to update BaseConfig object

0.4.* (2020-06)

  • Refatory configure function

  • Support property configuration

0.3.* (2020-03)

  • Add proxy and lazy module.

  • Add find_caller to trace source of config value

  • Refactory ConfigMeta data structure

0.2.* (2019-08)

  • Change global variable to weak reference

  • Remove Lock (Prepare to implement optimistic raw lock if necessary)

  • Improve Priority Data Structure

  • Improve Field Validation

  • Use OOP to define call function

  • Properer validation and typecast

  • Improve Type Annotations

  • Import JSON type

0.1.0 (2019-08-01)

  • Init Project.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

configalchemy-0.5.5.tar.gz (24.5 kB view hashes)

Uploaded Source

Built Distribution

configalchemy-0.5.5-py2.py3-none-any.whl (13.7 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page