Contents

Overview

docs Documentation Status
tests
Travis-CI Build Status AppVeyor Build Status Requirements Status
Coverage Status
package PyPI Package latest release PyPI Package monthly downloads PyPI Wheel Supported versions Supported implementations

Helpers to configure Django settings by environment variables

The goal of this package is to help making your Django settings configurable via environment variables, while keeping everything as simple and decoupled as possible.

Installation

At the command line:

pip install rf-django-envconfig

Usage

To use rf-django-envconfig in a project:

import rf_django_envconfig

Reference

rf_django_envconfig

rf_django_envconfig.get_bool(env, name, default=False)[source]

Get a boolean value from the environment

If name is not found in env, return True if default evaluates to True, otherwise return False.

The following values are considered False:

  • 'False'
  • 'false'
  • 'Off'
  • 'off'
  • '0'
  • 'No'
  • 'no'
  • ''

Any other value is considered True.

rf_django_envconfig.get_db_url(env, name, default='')[source]

Get a settings.DATABASES entry from a URL in the environment

This is just a thin convenience wrapper around dj-database-url.

If name is not found in env, return the result of parsing default.

DATABASES = {
    'default': get_db_url(
        os.environ,
        'DATABASE_URL',
        default='postgres://myuser:mypassword@localhost/myproject'
    )
}
rf_django_envconfig.get_list(env, name, default=None)[source]

Get a list from the environment

The input is assumed to be a comma-separated list of strings.

If name is not found in env, return default. Note that default is returned as-is, so you should usually specify it as a list:

ALLOWED_HOSTS = get_list(os.environ, 'ALLOWED_HOSTS', ['localhost', ])

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Bug reports

When reporting a bug please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Documentation improvements

rf-django-envconfig could always use more documentation, whether as part of the official rf-django-envconfig docs, in docstrings, or even on the web in blog posts, articles, and such.

Feature requests and feedback

The best way to send feedback is to file an issue at https://github.com/rfleschenberg/rf-django-envconfig/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that code contributions are welcome :)

Development

To set up rf-django-envconfig for local development:

  1. Fork rf-django-envconfig (look for the “Fork” button).

  2. Clone your fork locally:

    git clone git@github.com:your_name_here/rf-django-envconfig.git

  3. Create a branch for local development:

    git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  4. When you’re done making changes, run all the checks, doc builder and spell checker with tox one command:

    tox

  5. Commit your changes and push your branch to GitHub:

    git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature

  6. Submit a pull request through the GitHub website.

Pull Request Guidelines

If you need some code review or feedback while you’re developing the code just make the pull request.

For merging, you should:

  1. Include passing tests (run tox) [1].
  2. Update documentation when there’s new API, functionality etc.
  3. Add a note to CHANGELOG.rst about the changes.
  4. Add yourself to AUTHORS.rst.
[1]

If you don’t have all the necessary python versions available locally you can rely on Travis - it will run the tests for each change you add in the pull request.

It will be slower though ...

Tips

To run a subset of tests:

tox -e envname -- py.test -k test_myfeature

To run all the test environments in parallel (you need to pip install detox):

detox

Authors

Changelog

0.1.0 (2016-12-15)

  • First release on PyPI.

Indices and tables