A cookiecutter template for scientific Python projects in the field of hydrology.
Project description
Main features
- Poetry for dependency management
- GitHub Actions
- Pre-commit hooks with pre-commit
- Code quality with ruff, mypy, deptry and prettier
- Containerization with Docker
- Development environment with VSCode devcontainers
Quickstart
On your local machine, navigate to the directory in which you want to create a project directory, and run the following two commands:
pip install cookiecutter-hydro
cchydro
Alternatively, install cookiecutter and directly pass the URL to this
Github repository to the cookiecutter command:
pip install cookiecutter
cookiecutter https://github.com/zawadzkim/cookiecutter-hydro.git
Create a repository on GitHub, and then run the following commands, replacing <project-name>, with the name that you gave the Github repository and
<github_author_handle> with your Github username.
cd <project_name>
git init -b main
git add .
git commit -m "Init commit"
git remote add origin git@github.com:<github_author_handle>/<project_name>.git
git push -u origin main
Finally, install the environment and the pre-commit hooks with
make install
You are now ready to start development on your project!
Acknowledgements
This project is a fork of Cookiecutter Poetry and is partly inspired by Cookiecutter Data Science project, but is tailored for use in hydrological research.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
