Make config files from Django settings variables and templates.
## Installation
From your Django app, install the module from pip:
pip install django-makeconf
Then make sure it's included in your `INSTALLED_APPS` section:
INSTALLED_APPS = (
...
'makeconf',
)
## Templates
Create templates in the `templates/` directory of your app. For example, if you create `myapp/templates/makeconf/Dockerfile.tmpl`, you can generate `Dockerfile` in the root of your app by configuring `MAKECONF_MAP` in your settings file:
MAKECONF_MAP = {
'Dockerfile': 'makeconf/Dockerfile.tmpl',
}
This relies on Django's template finder, which is pretty flexible. It will scan all your apps for a template with the same path name. The `Dockerfile` will be generated using the `Dockerfile.tmpl`, and it will have access to the `settings` variable.
## Elastic Beanstalk Modules
Elastic Beanstalk configuration files can be declared using `MAKECONF_EB_MODULES`. Templates named `<module_name>.tmpl` can be referenced in a list by the module name. If you had a `newrelic` module and a `postgres` module that each configure your server with packages, files, etc., you can automatically turn the following format:
MAKECONF_EB_MODULES = ['postgres', 'newrelic']
Into additional `MAKECONF_MAP` entries like so:
MAKECONF_MAP = {
...
'.ebextensions/01_postgres.config': 'postgres.tmpl',
'.ebextensions/02_newrelic.config': 'newrelic.tmpl',
}
If `MAKECONF_EB_MODULES` is set, `.ebextensions` will be erased with each build.
## Options
Currently, there is one option which can be set using `MAKECONF_OPTIONS`:
* `executable_extensions` - Files with extensions in this list will be created executable. Defaults to `['.sh']`.
## Usage
Assuming you have a `TIER` variable defined as `'qa'` in your settings file and the following template,
FROM amazon/aws-eb-python:3.4.2-onbuild-3.5.1
ADD uwsgi-start.sh /
ENV DJANGO_SETTINGS_MODULE config.settings.{{ settings.TIER }}
EXPOSE 8080
you could run
python manage.py makeconf
and `{{ settings.TIER }}` would be replaced with `qa` in the output file.
## Template Tags
* `environ` - The `environ` tag is used to get required variables from the shell environment:
* To use it, first, load the `makeconf` template tags in your template:
{% load makeconf %}
* Then, use the tag in that template:
{{'MY_ENVIRONMENT_VARIABLE'|environ}}
## Shared Templates
If people use this, I could see shareable formats published for different services and needs. I'm currently using it to build Elastic Beanstalk and Docker configurations based on my Django settings, so I may end up publishing Django apps with names like `django-makeconf-elasticbeanstalk-configure-proxy`, or `django-makeconf-eb-docker-settings-module`, which would simply contain templates in their `templates/` directories (plus a `setup.py` and a `MANIFEST.in` that included the template files). You'd be able to pip install those templates and use them directly in your `MAKECONF_MAP`.
Also, I'm totally open to contributions in that vein or pull requests / issues on this project.
Metadata
Release files for django-makeconf 1.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| django-makeconf-1.1.1.tar.gz | 4.3 kB | Without provenance | Details for django-makeconf-1.1.1.tar.gz |
Release files / django-makeconf-1.1.1.tar.gz
| Download URL | django-makeconf-1.1.1.tar.gz |
|---|---|
| Size | 4.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8514a6bf54f105f7b3e404b84526c6798b78faf5a3fa7c16d414376873e99c95
|
|
BLAKE2b-256 checksum How to use checksums |
390502b86124cb338f848f47eb3cc00c2bee5b30fdde86849afdd56a2c05f935
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for django-makeconf 1.1.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.