Package: tox-envfile
tox-envfileLoad env files in your tox envs.tox-envfile reads environment variables from a file named.devdata.envin the
same directory as yourtox.inifile and adds them to the environment that tox
runs your commands in.This is a pretty dumb plugin for now: all of the environment variables in.devdata.envwill be loaded into the environment for every tox env that you
run, unconditionally. Any existing envvars with conflicting names will be
overwritten. Only a single environment file is supported and it must be named.devdata.env.env File Formatpython-dotenvis used for the env file parsing.The.devdata.envfile should be an env file with contents that look like
this:# a comment that will be ignored.REDIS_ADDRESS=localhost:6379MEANING_OF_LIFE=42MULTILINE_VAR="hello\nworld"Or like this:exportS3_BUCKET=YOURS3BUCKETexportSECRET_KEY=YOURSECRETKEYGOESHEREPOSIX variable expansion works, using variables from the environment or from
earlier lines in the env file:CONFIG_PATH=${HOME}/.config/fooDOMAIN=example.orgEMAIL=admin@${DOMAIN}Setting up Your tox-envfile Development EnvironmentFirst you'll need to install:Git.
On Ubuntu:sudo apt install git, on macOS:brew install git.GNU Make.
This is probably already installed, runmake --versionto check.pyenv.
Follow the instructions in pyenv's README to install it.
TheHomebrewmethod works best on macOS.
TheBasic GitHub Checkoutmethod works best on Ubuntu.
Youdon'tneed to set up pyenv's shell integration ("shims"), you canuse pyenv without shims.Then to set up your development environment:git clone https://github.com/hypothesis/tox-envfile.git
cd tox_envfile
make helpReleasing a New Version of the ProjectFirst, to get PyPI publishing working you need to go to:https://github.com/organizations/hypothesis/settings/secrets/actions/PYPI_TOKENand add tox-envfile to thePYPI_TOKENsecret's selected
repositories.Now that the tox-envfile project has access to thePYPI_TOKENsecret
you can release a new version by justcreating a new GitHub release.
Publishing a new GitHub release will automatically triggera GitHub Actions workflowthat will build the new version of your Python package and upload it tohttps://pypi.org/project/tox-envfile.Changing the Project's Python VersionsTo change what versions of Python the project uses:Change the Python versions in thecookiecutter.jsonfile. For example:"python_versions":"3.10.4, 3.9.12",Re-run the cookiecutter template:make templateCommit everything to git and send a pull requestChanging the Project's Python DependenciesTo change the production dependencies in thesetup.cfgfile:Change the dependencies in the.cookiecutter/includes/setuptools/install_requiresfile.
If this file doesn't exist yet create it and add some dependencies to it.
For example:pyramid
sqlalchemy
celeryRe-run the cookiecutter template:make templateCommit everything to git and send a pull requestTo change the project's formatting, linting and test dependencies:Change the dependencies in the.cookiecutter/includes/tox/depsfile.
If this file doesn't exist yet create it and add some dependencies to it.
Use tox'sfactor-conditional settingsto limit which environment(s) each dependency is used in.
For example:lint: flake8,
format: autopep8,
lint,tests: pytest-faker,Re-run the cookiecutter template:make templateCommit everything to git and send a pull requestTesting ManuallyTo test it manually you can install your local development copy oftox-envfileinto the local development environment of another tox-using
project such ascookiecutter-pypackage-test:Install a local development copy ofcookiecutter-pypackage-testin a temporary directory:git clone https://github.com/hypothesis/cookiecutter-pypackage-test.git /tmp/cookiecutter-pypackage-testRuncookiecutter-pypackage-test'smake surecommand to make sure that
everything is working and to trigger tox to create its.tox/.toxvenv:make --directory "/tmp/cookiecutter-pypackage-test" sureUninstall the production copy oftox-envfilefromcookiecutter-pypackage-test's.tox/.toxvenv:/tmp/cookiecutter-pypackage-test/.tox/.tox/bin/pip uninstall tox-envfileInstall your local development copy oftox-envfileintocookiecutter-pypackage-test's.tox/.toxvenv:/tmp/cookiecutter-pypackage-test/.tox/.tox/bin/pip install -e .Nowcookiecutter-pypackage-testcommands will use your local development copy oftox-envfile:make --directory "/tmp/cookiecutter-pypackage-test" test