description
This project is developed in collaboration with the Centre for Advanced Research Computing, University College London.
Eva Lu Ator ([email protected])
Centre for Advanced Research Computing, University College London ([email protected])
cookiecutter-test requires Python 3.11–3.14.
We recommend installing in a project specific virtual environment created using
a environment management tool such as
uv. To install the latest
development version of cookiecutter-test using uv pip in the currently active
environment run
uv pip install git+https://github.com/test-user/cookiecutter-test.gitAlternatively create a local clone of the repository with
git clone https://github.com/test-user/cookiecutter-test.gitand then install in editable mode by running
uv pip install -e .How to run the application on your local system.
Tests can be run across all compatible Python versions in isolated environments
using tox by running
toxTo run tests manually in a Python environment with pytest installed run
pytest testsagain from the root of the repository.
The MkDocs HTML documentation can be built locally by running
tox -e docsfrom the root of the repository. The built documentation will be written to
site.
Alternatively to build and preview the documentation locally, in a Python
environment with the docs dependency group installed, run
mkdocs serve- Initial Research
- Minimum viable product <-- You are Here
- Alpha Release
- Feature-Complete Release