Skip to main content

Convenient configuration of containerized applications

Project description

container-app-conf Contributors MIT License Code Size https://badge.fury.io/py/container-app-conf Build Status

container-app-conf is a library to easily read application configuration values from multiple sources (YAML, env) while providing type validation.

The initial purpose of this library was to have an easy way to configure an application running inside of a container using environment variables (Docker in this case) and still provide the possibility to use a more simple form of configuration like a YAML file.

container-app-conf is used by

and hopefully many others :)

How to use

pip install container-app-conf

Extend Config base

from container_app_conf import Config
from container_app_conf.entry.string import StringConfigEntry

class AppConfig(Config):

    @property
    def config_file_names(self) -> [str]:
        return ["my_app_config_file_name"]

    MY_CONFIG = StringConfigEntry(
        yaml_path=[
            "my_app_config_file_name",
            "example"
        ],
        none_allowed=False)

Config Types

Name Description Type
BoolConfigEntry Parses bool, int (0 and 1) and str values (yes, no etc.) to a boolean value bool
IntConfigEntry Parses input to an integer int
FloatConfigEntry Parses input to a floating number float
StringConfigEntry Takes the raw string input str
DateConfigEntry Parses various datetime formats (see python-dateutil) datetime
TimeDeltaConfigEntry Parses various timedelta formats (see pytimeparse) timedelta
ListConfigEntry Parses a comma separated string to a list of items specified in another ConfigEntry (in yaml it can also be specified as a yaml list) []

If none of the existing types suit your needs you can easily create your own by extending the ConfigEntry base class.

Default Values

A default value can be specified for every ConfigEntry by using the default constructor parameter.

Allow None

By default a None value is only allowed if the default value is None. This means it is not possible to set the MY_CONFIG entry in the example at the top to None even after initial parsing. Specifying an empty text in the yaml or corresponding environment variable will result in an exception. If you want to allow setting a None value even if the default value is not None, use the none_allowed=True constructor parameter.

Contributing

GitHub is for social coding: if you want to write code, I encourage contributions through pull requests from forks of this repository. Create GitHub tickets for bugs and new features and comment on the ones that you are interested in.

License

container-app-conf
Copyright (c) 2019 Markus Ressel

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

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

container_app_conf-1.2.0.tar.gz (9.0 kB view details)

Uploaded Source

Built Distribution

container_app_conf-1.2.0-py3-none-any.whl (21.1 kB view details)

Uploaded Python 3

File details

Details for the file container_app_conf-1.2.0.tar.gz.

File metadata

  • Download URL: container_app_conf-1.2.0.tar.gz
  • Upload date:
  • Size: 9.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.6.7

File hashes

Hashes for container_app_conf-1.2.0.tar.gz
Algorithm Hash digest
SHA256 203543521750a5fac259afbbdb142420037d2427a5ed096e8b8e22d580be596b
MD5 beb1a69c2993c46b067d910a97cd987a
BLAKE2b-256 1092fafabb8064a5c58189f66f99a861e5f10bf9ca243ff790a535a924520af9

See more details on using hashes here.

Provenance

File details

Details for the file container_app_conf-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: container_app_conf-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 21.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.6.7

File hashes

Hashes for container_app_conf-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0fe9ef083d3e95bb33e0fc1f538c5bd30cad0bb873d2f1a2d675d64adac716c4
MD5 2e863b2d876d7daafd8496d9f8423366
BLAKE2b-256 7dfc6673b8d4ad24698865075a2f291059d0157e866dddb1e19e421851341653

See more details on using hashes here.

Provenance

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