https://github.com/pytroll/donfig

Python library for configuring a package including defaults, env variable loading, and yaml loading.
https://github.com/pytroll/donfig

configuration hacktoberfest python

Last synced: 4 days ago
JSON representation

Python library for configuring a package including defaults, env variable loading, and yaml loading.

• Host: GitHub
• URL: https://github.com/pytroll/donfig
• Owner: pytroll
• License: mit
• Created: 2018-11-03T01:00:50.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2025-01-08T18:41:44.000Z (22 days ago)
• Last Synced: 2025-01-19T15:13:01.930Z (11 days ago)
• Topics: configuration, hacktoberfest, python
• Language: Python
• Homepage: https://donfig.readthedocs.io/en/latest/
• Size: 318 KB
• Stars: 37
• Watchers: 7
• Forks: 10
• Open Issues: 4
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt
  • Authors: AUTHORS.md

Awesome Lists containing this project

README

        
Donfig

======

.. image:: https://github.com/pytroll/donfig/workflows/CI/badge.svg?branch=main

    :target: https://github.com/pytroll/donfig/actions?query=workflow%3A%22CI%22

.. image:: https://codecov.io/gh/pytroll/donfig/branch/main/graph/badge.svg?token=xmvNtxzdoB

   :target: https://codecov.io/gh/pytroll/donfig

.. image:: https://anaconda.org/conda-forge/donfig/badges/version.svg

   :target: https://anaconda.org/conda-forge/donfig/

.. image:: https://results.pre-commit.ci/badge/github/pytroll/donfig/main.svg

   :target: https://results.pre-commit.ci/latest/github/pytroll/donfig/main

   :alt: pre-commit.ci status

Donfig is a python library meant to make configuration easier for other

python packages. Donfig can be configured programmatically, by

environment variables, or from YAML files in standard locations. The

below examples show the basics of using donfig. For more details see the

official `documentation `_.

Installation

------------

Donfig can be installed from PyPI using pip:

.. code-block:: bash

    pip install donfig

Or with conda using the conda-forge channel:

.. code-block:: bash

    conda install -c conda-forge donfig

Using Donfig

------------

Create the package-wide configuration object for your package named `mypkg`:

.. code-block:: python

    # mypkg/__init__.py

    from donfig import Config

    config = Config('mypkg')

Use the configuration object:

.. code-block:: python

    from mypkg import config

    important_val = config.get('important_key')

    if important_val:

        # do something

    else:

        # something else

Set configuration in Python

---------------------------

Configuration can be modified in python before code using it is called:

.. code-block:: python

    # mypkg/work.py

    from mypkg import config

    config.set(important_key=5)

    # use the configuration

Donfig configurations can also be changed as a context manager:

.. code-block:: python

    config.set(other_key=True)

    with config.set(other_key=False):

        print(config.get('other_key'))  # False

    print(config.get('other_key'))  # True

Configure from environment variables

------------------------------------

Environment variables are automatically loaded when the Config object is

created. Any environment variable starting with the name of the config

object in all capital letters and an underscore will be loaded in to

the config object:

.. code-block:: bash

    export MYPKG_MY_KEY="a value"

And can be accessed in python:

.. code-block:: python

    from mypkg import config

    print(config.get('my_key'))

Configure from YAML file

------------------------

Donfig will also automatically load any YAML configuration files found in

specific paths. The default paths:

- ~/.config//

- /etc//

- /etc//

Note the `/etc//` directory can also be specified with the

environment variable `DASK_ROOT_CONFIG`. Also note that

`~/.config/` (or other location specified with `DASK_CONFIG`)

can be created as a custom user configuration file for easier user

customization (see documentation for details).

History

-------

Donfig is based on the original configuration logic of the `dask` library.

The code has been modified to use a config object instead of a global

configuration dictionary. This makes the configuration logic of dask available

to everyone. The name "donfig" is a shortening of "dask.config", the original

dask module that implemented this functionality.

License

-------

Original code from the dask library was distributed under the license

specified in `DASK_LICENSE.txt`. In November 2018 this code was migrated to

the Donfig project under the MIT license described in `LICENSE.txt`. The full

copyright for this project is therefore::

    Copyright (c) 2018 Donfig Developers

    Copyright (c) 2014-2018, Anaconda, Inc. and contributors