Package: tox-recreate
tox-recreateRecreate tox virtual environments when setup.cfg changes.tox-recreate causes tox to recreate its virtualenv's if yoursetup.cfgfile has changed.Normally tox will automatically trigger a recreation of the venv if the testdepsintox.inihave changed. But what about your package's requirements in
theinstall_requiressetting insetup.cfg? If those change tox won't
automatically recreate the venv, you're expected to runtox --recreateyourself.tox-recreate keeps track of the hash of yoursetup.cfgfile and triggers tox
to recreate your venvs if it changes.Setting up Your tox-recreate 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-recreate.git
cd tox_recreate
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-recreate to thePYPI_TOKENsecret's selected
repositories.Now that the tox-recreate 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-recreate.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-recreateinto 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-recreatefromcookiecutter-pypackage-test's.tox/.toxvenv:/tmp/cookiecutter-pypackage-test/.tox/.tox/bin/pip uninstall tox-recreateInstall your local development copy of tox-recreate intocookiecutter-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-recreate:make --directory "/tmp/cookiecutter-pypackage-test" test