Skip to main content

Environment variable manager

Project description

============================================
Knobs are used to tune environment variables
============================================

.. image:: pics/knob.jpg

Use *knobs* if you worship at the church of the `12 Factor App <http://www.12factor.net/>`_

A knob is a wrapper for an environment variable. It can
* Read and write an environment variable
* Make sure it is of the expected type
* Validate a value is good.

.. code::
>>> pirates = Knob('JOLLY_ROGER_PIRATES', 124, description='Yar')
>>> pirates.get()
124
>>> pirates.get_type

*knobs* will search for a nominated environmental file (default *.env*) and load that
into the environment. A knob is type aware, configured from the environment and its value can be
persisted to ease the creation of configuration files.

Knobs uses a forked copy of `python-sotenv <https://github.com/theskumar/python-dotenv>`_


Install
=======

Install from pypi

.. code::

$ pip install knobs

Install from source

.. code::

$ pip install .



Versioning
==========

Current version is 0.2.2

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

knobs-0.2.2-py2-none-any.whl (4.2 kB view details)

Uploaded Python 2

File details

Details for the file knobs-0.2.2-py2-none-any.whl.

File metadata

File hashes

Hashes for knobs-0.2.2-py2-none-any.whl
Algorithm Hash digest
SHA256 e361ab409edcd0ddaf10fba7b61077b432c2c6a7e56f924f6b62a00b8849a6b4
MD5 c740f84bcc126951555b457b7c0f5cd3
BLAKE2b-256 3b1f1b308f68c9bb6af537dda1d115a707849e043da1feb0fb8b6e97fc06ce57

See more details on using hashes here.

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