Skip to main content

A small package to automatically find a configuration file.

Project description

A system to resolve config files for python projects
====================================================

A very simple and small utility to provide a way to search for configuration
files. For now it is only tested on posix systems, but it should also work on
Windows.

For posix systems it will search for config files in the following order:

- ``/etc/<group_name>/<app_name>/<conf_name>``
- ``~/.<group_name>/<app_name>/<conf_name>``
- The current active working directory (of the running process)
- [optional] Any paths specified in the environment variable ``<APP_NAME>_PATH``
- A file named in the environment variable ``<APP_NAME>_CONFIG``

The complete search path can be controlled by setting the environment variable
``<APP_NAME>_PATH``, separating the different paths by either ``:`` (posix) or
``;`` (windows). If the folder in the ``<APP_NAME>_PATH`` begins with a ``+``,
then the paths in that variable will be *appended* to the default search path
instead of replacing the path.

The last file found will always take precedence by extending/overwriting
previously loaded files. As an example you can have system globals in
``/etc``, and then on a per-user basis override values. Existing values are
kept, so config files further down the lookup chain do not contain all values.

Even further down the lookup chain you can use the working-directory or
``<APP_NAME>_CONFIG`` to override values on a per-application instance basis.


Changelog
=========

.. include:: CHANGES

Project details


Release history Release notifications

History Node

5.0.0a2

History Node

5.0.0a1

History Node

4.2.4

History Node

4.2.3

History Node

4.2.2

History Node

4.2.1

History Node

4.2.0

History Node

4.1.2

History Node

4.1.0

History Node

4.0.0

History Node

3.3.0

This version
History Node

3.2.1

History Node

3.1

History Node

3.0

History Node

2.1

History Node

2.0.1

History Node

2.0

History Node

1.1

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
config_resolver-3.2.1.tar.gz (4.5 kB) Copy SHA256 hash SHA256 Source None Jun 3, 2013

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page