Package: ckanext-envvars
[![image](https://github.com/okfn/ckanext-envvars/actions/workflows/test.yml/badge.svg)](https://github.com/okfn/ckanext-envvars/actions)ckanext-envvarsThis CKAN extension checks for environmental variables conforming to an
expected format and updates the corresponding CKAN config settings with
its value.For the extension to correctly identify which env var keys map to the
format used for the config object, env var keys should be formatted in
the following way:All uppercaseReplace periods ('.') with two underscores ('__')Keys must begin with 'CKAN' or 'CKANEXT'Some examples:ckan.site_id –> CKAN__SITE_ID
ckanext.s3filestore.aws_bucket_name –> CKANEXT__S3FILESTORE__AWS_BUCKET_NAMEFor keys that don't normally begin with 'CKAN', add 'CKAN___' (3
underscores) to the beginning to help the extension identify these keys,
e.g.:sqlalchemy.url –> CKAN___SQLALCHEMY__URL
beaker.session.secret –> CKAN___BEAKER__SESSION__SECRETRequirementsTested in CKAN 2.7, CKAN 2.8, CKAN 2.9 and CKAN 2.10, but may work in other
versions.To ensure all config settings are overridden by env var values,envvarsmust be the last plugin entry in theckan.pluginslist (see
'Installation' below).InstallationTo install ckanext-envvars:Activate your CKAN virtual environment, for example:. /usr/lib/ckan/default/bin/activateInstall the ckanext-envvars Python package into your virtual
environment:pip install ckanext-envvarsAddenvvarsto theckan.pluginssetting in your CKAN config file
(by default the config file is located at/etc/ckan/default/production.ini).Restart CKAN. For example if you've deployed CKAN with Apache on
Ubuntu:sudo service apache2 reloadDevelopment InstallationTo install ckanext-envvars for development, activate your CKAN
virtualenv and do:git clonehttps://github.com/okfn/ckanext-envvars.gitcd ckanext-envvars
python setup.py develop
pip install -r dev-requirements.txtRunning the TestsThey follow the guidelines for [testing CKAN extensions](https://docs.ckan.org/en/2.8/extensions/testing-extensions.html#testing-extensions).To run the tests, do:> pytest –ckan-ini=test.ini ckanext/envvars/tests.pyRegistering ckanext-envvars on PyPIckanext-envvars should be availabe on PyPI as
<https://pypi.python.org/pypi/ckanext-envvars>. If that link doesn't
work, then you can register the project on PyPI for the first time by
following these steps:Create a source distribution of the project:python setup.py sdistRegister the project:python setup.py registerUpload the source distribution to PyPI:python setup.py sdist uploadTag the first release of the project on GitHub with the version
number from thesetup.pyfile. For example if the version number
insetup.pyis 0.0.1 then do:git tag 0.0.1
git push –tagsReleasing a New Version of ckanext-envvarsckanext-envvars is availabe on PyPI as
<https://pypi.python.org/pypi/ckanext-envvars>. To publish a new version
to PyPI follow these steps:Update the version number in thesetup.pyfile. See [PEP
440](http://legacy.python.org/dev/peps/pep-0440/#public-version-identifiers)
for how to choose version numbers.Create a source distribution of the new version:python setup.py sdistUpload the source distribution to PyPI:python setup.py sdist uploadTag the new release of the project on GitHub with the version number
from thesetup.pyfile. For example if the version number insetup.pyis 0.0.2 then do:git tag 0.0.2
git push –tags