Write less unittest boilerplate.
The most recent release can be installed from PyPI with:
$ pip install unittest_templatesThe most recent code and data can be installed directly from GitHub with:
$ pip install git+https://github.com/cthoyt/unittest-templates.gitTo install in development mode, use the following:
$ git clone git+https://github.com/cthoyt/unittest-templates.git
$ cd unittest-templates
$ pip install -e .The code in this package is licensed under the MIT License.
Contributions, whether filing an issue, making a pull request, or forking, are appreciated. See CONTRIBUTING.rst for more information on getting involved.
This package was created with @audreyfeldroy's cookiecutter package using @cthoyt's cookiecutter-python-package template.
The final section of the README is for if you want to get involved by making a code contribution.
After cloning the repository and installing tox with pip install tox, the unit tests in the tests/ folder can be
run reproducibly with:
$ toxAdditionally, these tests are automatically re-run with each commit in a GitHub Action.
After installing the package in development mode and installing
tox with pip install tox, the commands for making a new release are contained within the finish environment
in tox.ini. Run the following from the shell:
$ tox -e finishThis script does the following:
- Uses BumpVersion to switch the version number in the
setup.cfgandsrc/unittest_templates/version.pyto not have the-devsuffix - Packages the code in both a tar archive and a wheel
- Uploads to PyPI using
twine. Be sure to have a.pypircfile configured to avoid the need for manual input at this step - Push to GitHub. You'll need to make a release going with the commit where the version was bumped.
- Bump the version to the next patch. If you made big changes and want to bump the version by minor, you can
use
tox -e bumpversion minorafter.