[](https://pypi.org/project/cookiecutter-hydro/)
[](https://github.com/zawadzkim/cookiecutter-hydro/actions/workflows/main.yml?query=branch%3Amain)
[](https://pypi.org/project/cookiecutter-hydro/)
[](https://zawadzkim.github.io/cookiecutter-hydro/)
[](https://img.shields.io/github/license/zawadzkim/cookiecutter-hydro)
## Main features
- [Poetry](https://python-poetry.org/) for dependency management
- [GitHub Actions](https://github.com/features/actions)
- Pre-commit hooks with [pre-commit](https://pre-commit.com/)
- Code quality with [ruff](https://github.com/charliermarsh/ruff), [mypy](https://mypy.readthedocs.io/en/stable/), [deptry](https://github.com/zawadzkim/deptry/) and [prettier](https://prettier.io/)
- Containerization with [Docker](https://www.docker.com/)
- Development environment with [VSCode devcontainers](https://code.visualstudio.com/docs/devcontainers/containers)
## Quickstart
On your local machine, navigate to the directory in which you want to
create a project directory, and run the following two commands:
```bash
pip install cookiecutter-hydro
cchydro
```
Alternatively, install `cookiecutter` and directly pass the URL to this
Github repository to the `cookiecutter` command:
```bash
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.
```bash
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
```bash
make install
```
You are now ready to start development on your project!
## Acknowledgements
This project is a fork of [Cookiecutter Poetry](https://github.com/zawadzkim/cookiecutter-hydro-example) and is partly inspired by [Cookiecutter Data Science](https://github.com/drivendataorg/cookiecutter-data-science) project, but is tailored for use in hydrological research.
Raw data
{
"_id": null,
"home_page": "https://github.com/zawadzkim/cookiecutter-hydro",
"name": "cookiecutter-hydro",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": "cookiecutter, template, poetry",
"author": "Mateusz Zawadzki",
"author_email": "zawadzkimat@outlook.com",
"download_url": "https://files.pythonhosted.org/packages/eb/95/99f208705426fca266a9e433cd7a6456529a495fdcf0b203f0e32d3aa844/cookiecutter_hydro-0.0.1.tar.gz",
"platform": null,
"description": "[](https://pypi.org/project/cookiecutter-hydro/)\n[](https://github.com/zawadzkim/cookiecutter-hydro/actions/workflows/main.yml?query=branch%3Amain)\n[](https://pypi.org/project/cookiecutter-hydro/)\n[](https://zawadzkim.github.io/cookiecutter-hydro/)\n[](https://img.shields.io/github/license/zawadzkim/cookiecutter-hydro)\n\n## Main features\n\n- [Poetry](https://python-poetry.org/) for dependency management\n- [GitHub Actions](https://github.com/features/actions)\n- Pre-commit hooks with [pre-commit](https://pre-commit.com/)\n- Code quality with [ruff](https://github.com/charliermarsh/ruff), [mypy](https://mypy.readthedocs.io/en/stable/), [deptry](https://github.com/zawadzkim/deptry/) and [prettier](https://prettier.io/)\n- Containerization with [Docker](https://www.docker.com/)\n- Development environment with [VSCode devcontainers](https://code.visualstudio.com/docs/devcontainers/containers)\n\n## Quickstart\n\nOn your local machine, navigate to the directory in which you want to\ncreate a project directory, and run the following two commands:\n\n```bash\npip install cookiecutter-hydro\ncchydro\n```\n\nAlternatively, install `cookiecutter` and directly pass the URL to this\nGithub repository to the `cookiecutter` command:\n\n```bash\npip install cookiecutter\ncookiecutter https://github.com/zawadzkim/cookiecutter-hydro.git\n```\n\nCreate a repository on GitHub, and then run the following commands, replacing `<project-name>`, with the name that you gave the Github repository and\n`<github_author_handle>` with your Github username.\n\n```bash\ncd <project_name>\ngit init -b main\ngit add .\ngit commit -m \"Init commit\"\ngit remote add origin git@github.com:<github_author_handle>/<project_name>.git\ngit push -u origin main\n```\n\nFinally, install the environment and the pre-commit hooks with\n\n```bash\nmake install\n```\n\nYou are now ready to start development on your project!\n\n## Acknowledgements\n\nThis project is a fork of [Cookiecutter Poetry](https://github.com/zawadzkim/cookiecutter-hydro-example) and is partly inspired by [Cookiecutter Data Science](https://github.com/drivendataorg/cookiecutter-data-science) project, but is tailored for use in hydrological research.\n",
"bugtrack_url": null,
"license": null,
"summary": "A cookiecutter template for scientific Python projects in the field of hydrology.",
"version": "0.0.1",
"project_urls": {
"Documentation": "https://zawadzkim.github.io/cookiecutter-hydro/",
"Homepage": "https://github.com/zawadzkim/cookiecutter-hydro",
"Repository": "https://github.com/zawadzkim/cookiecutter-hydro"
},
"split_keywords": [
"cookiecutter",
" template",
" poetry"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "055d52f9a11138e91514afecb3f01d86765a35387c27d878c0fc4454cff90b1f",
"md5": "1aa3462bc07c997fd3b8fd9468fb37ec",
"sha256": "72b3dd5529ad82dd82e4db790d8c80f62ce854463f8be27b250b14a50f52f0c4"
},
"downloads": -1,
"filename": "cookiecutter_hydro-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1aa3462bc07c997fd3b8fd9468fb37ec",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 24765,
"upload_time": "2024-10-17T09:21:13",
"upload_time_iso_8601": "2024-10-17T09:21:13.863880Z",
"url": "https://files.pythonhosted.org/packages/05/5d/52f9a11138e91514afecb3f01d86765a35387c27d878c0fc4454cff90b1f/cookiecutter_hydro-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "eb9599f208705426fca266a9e433cd7a6456529a495fdcf0b203f0e32d3aa844",
"md5": "31f6d6c9144c6ca840228aab5d37c0a0",
"sha256": "8fca4439165d110033fe69c00037ab1f1385d7d868f4ee910f4f0f8b50685a85"
},
"downloads": -1,
"filename": "cookiecutter_hydro-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "31f6d6c9144c6ca840228aab5d37c0a0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 14917,
"upload_time": "2024-10-17T09:21:15",
"upload_time_iso_8601": "2024-10-17T09:21:15.580916Z",
"url": "https://files.pythonhosted.org/packages/eb/95/99f208705426fca266a9e433cd7a6456529a495fdcf0b203f0e32d3aa844/cookiecutter_hydro-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-17 09:21:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zawadzkim",
"github_project": "cookiecutter-hydro",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "cookiecutter-hydro"
}
JSON
