mirror of
Fork 0

Document how to run the unit tests locally

When verifying the steps on Windows, the `.eggs` directory suddenly appeared.
This is now ignored.
This commit is contained in:
Kurt McKee 2022-05-18 07:01:39 -05:00
parent 7a586aa4c5
commit d12aa83673
2 changed files with 26 additions and 0 deletions

.gitignore vendored
View File

@ -1,6 +1,7 @@

View File

@ -50,6 +50,31 @@ used in the rest of the project. The version history should be clean, and
commit messages should be descriptive and [properly
When preparing a patch, it's recommended that you add unit tests
that demonstrate the bug is fixed (or that the feature works).
You can run the tests on your local machine by installing the `dev` extras.
The steps below do this using a virtual environment:
# Create a local virtual environment
$ python -m venv .venv
# Activate the virtual environment
# Cygwin, Linux, and MacOS:
$ . .venv/bin/activate
# Windows Powershell:
$ & .venv\Scripts\Activate.ps1
# Update pip and setuptools
(.venv) $ python -m pip install -U pip setuptools
# Install dotbot and its development dependencies
(.venv) $ python -m pip install -e .[dev]
# Run the unit tests
(.venv) $ tox
If you have any questions about anything, feel free to [ask][email]!