Package: tox-faster
tox-fasterA tox plugin that speeds up tox a little.Speedupstox-faster implements these tox speedups:Disables tox's dependency listing (the "env report")Every single time you run tox it runspip freezeto print out a list of all
the packages installed in the testenv being run:tox -e lintlint installed: aiohttp==3.8.1,aioresponses==0.7.3,aiosignal==1.2.0,
alembic==1.8.0,amqp==5.1.1,astroid==2.11.6,async-timeout==4.0.1,attrs==20.2.0,
...lint run-test-pre: PYTHONHASHSEED='2115099637'
lint run-test: commands[0] | pylint lms bin
...You don't need to see that in your terminal every time you run tox and if your
venv contains a lot of packages it's quite annoying because it prints
screenfulls of text. Runningpip freezealso introduces a noticeable delay in
the startup time of every tox command: on my machine with my venv it adds about
250ms.You can hide this output by running tox with-qbut that doesn't make tox run
any faster: it seems that it still runs thepip freezeeven though it doesn't
print it.tox-faster actually prevents tox from runningpip freezeso your tox output
will be shorter and your tox commands will start faster:$ tox -e lint
lint run-test-pre: PYTHONHASHSEED='3084948731'
lint run-test: commands[0] | pylint lms bin
...tox-faster doesn't disable the env report on CI.The env report can be useful diagnostic information on CI so if an environment
variable namedCIis set to any value then tox-faster won't disable the env report.
This also enables you to re-enable the env report locally by runningCI=true tox ....Setting up Your tox-faster 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-faster.git
cd tox_faster
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-faster to thePYPI_TOKENsecret's selected
repositories.Now that the tox-faster 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-faster.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-fasterinto 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-fasterfromcookiecutter-pypackage-test's.tox/.toxvenv:/tmp/cookiecutter-pypackage-test/.tox/.tox/bin/pip uninstall tox-fasterInstall your local development copy oftox-fasterintocookiecutter-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-faster:make --directory "/tmp/cookiecutter-pypackage-test" test