cookiecutter-hydro 0.0.1__tar.gz

cookiecutter_hydro-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Florian Maas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

cookiecutter_hydro-0.0.1/PKG-INFO

@@ -0,0 +1,74 @@
+Metadata-Version: 2.1
+Name: cookiecutter-hydro
+Version: 0.0.1
+Summary: A cookiecutter template for scientific Python projects in the field of hydrology.
+Home-page: https://github.com/zawadzkim/cookiecutter-hydro
+Keywords: cookiecutter,template,poetry
+Author: Mateusz Zawadzki
+Author-email: zawadzkimat@outlook.com
+Requires-Python: >=3.11,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: cookiecutter (>=2.1.1,<3.0.0)
+Project-URL: Documentation, https://zawadzkim.github.io/cookiecutter-hydro/
+Project-URL: Repository, https://github.com/zawadzkim/cookiecutter-hydro
+Description-Content-Type: text/markdown
+
+[![Release](https://img.shields.io/github/v/release/zawadzkim/cookiecutter-hydro)](https://pypi.org/project/cookiecutter-hydro/)
+[![Build status](https://img.shields.io/github/actions/workflow/status/zawadzkim/cookiecutter-hydro/main.yml?branch=main)](https://github.com/zawadzkim/cookiecutter-hydro/actions/workflows/main.yml?query=branch%3Amain)
+[![Supported Python versions](https://img.shields.io/pypi/pyversions/cookiecutter-hydro)](https://pypi.org/project/cookiecutter-hydro/)
+[![Docs](https://img.shields.io/badge/docs-gh--pages-blue)](https://zawadzkim.github.io/cookiecutter-hydro/)
+[![License](https://img.shields.io/github/license/zawadzkim/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.
+

cookiecutter_hydro-0.0.1/README.md

@@ -0,0 +1,56 @@
+[![Release](https://img.shields.io/github/v/release/zawadzkim/cookiecutter-hydro)](https://pypi.org/project/cookiecutter-hydro/)
+[![Build status](https://img.shields.io/github/actions/workflow/status/zawadzkim/cookiecutter-hydro/main.yml?branch=main)](https://github.com/zawadzkim/cookiecutter-hydro/actions/workflows/main.yml?query=branch%3Amain)
+[![Supported Python versions](https://img.shields.io/pypi/pyversions/cookiecutter-hydro)](https://pypi.org/project/cookiecutter-hydro/)
+[![Docs](https://img.shields.io/badge/docs-gh--pages-blue)](https://zawadzkim.github.io/cookiecutter-hydro/)
+[![License](https://img.shields.io/github/license/zawadzkim/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.

cookiecutter_hydro-0.0.1/cookiecutter.json

@@ -0,0 +1,22 @@
+{
+    "author": "Mateusz Zawadzki",
+    "email": "zawadzkimat@outlook.com",
+    "author_github_handle": "zawadzkim",
+    "project_name": "example-project",
+    "project_slug": "{{cookiecutter.project_name|lower|replace('-', '_')}}",
+    "project_description": "This is a template repository for Python projects that use Poetry for their dependency management.",
+    "include_github_actions": ["y", "n"],
+    "deptry": ["y", "n"],
+    "dockerfile": ["y", "n"],
+    "devcontainer": ["y", "n"],
+    "model": ["flopy", "swap", "pastas", "None"],
+    "gensor": ["y", "n"],
+    "open_source_license": [
+        "MIT license",
+        "BSD license",
+        "ISC license",
+        "Apache Software License 2.0",
+        "GNU General Public License v3",
+        "Not open source"
+    ]
+}

cookiecutter_hydro-0.0.1/cookiecutter_hydro/cli.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+import os
+
+
+def main() -> None:
+    cwd = os.path.dirname(__file__)
+    package_dir = os.path.abspath(os.path.join(cwd, ".."))
+    os.system(f"cookiecutter {package_dir}")  # noqa: S605 | No injection, retrieving path in OS

cookiecutter_hydro-0.0.1/hooks/post_gen_project.py

@@ -0,0 +1,37 @@
+#!/usr/bin/env python
+from __future__ import annotations
+
+import os
+import shutil
+
+PROJECT_DIRECTORY = os.path.realpath(os.path.curdir)
+
+
+def remove_file(filepath: str) -> None:
+    os.remove(os.path.join(PROJECT_DIRECTORY, filepath))
+
+
+def remove_dir(filepath: str) -> None:
+    shutil.rmtree(os.path.join(PROJECT_DIRECTORY, filepath))
+
+
+if __name__ == "__main__":
+    if "{{cookiecutter.include_github_actions}}" != "y":
+        remove_dir(".github")
+
+    if "{{cookiecutter.model}}" != "flopy":
+        remove_dir("{{cookiecutter.project_slug}}/src/modflow")
+        remove_dir("{{cookiecutter.project_slug}}/data/layers")
+        remove_dir("{{cookiecutter.project_slug}}/data/boundaries")
+
+    if "{{cookiecutter.model}}" != "swap":
+        remove_dir("{{cookiecutter.project_slug}}/src/swap")
+
+    if "{{cookiecutter.model}}" != "pastas":
+        remove_dir("{{cookiecutter.project_slug}}/src/pastas")
+
+    if "{{cookiecutter.dockerfile}}" != "y":
+        remove_file("Dockerfile")
+
+    if "{{cookiecutter.devcontainer}}" != "y":
+        remove_dir(".devcontainer")

cookiecutter_hydro-0.0.1/hooks/pre_gen_project.py

@@ -0,0 +1,22 @@
+from __future__ import annotations
+
+import re
+import sys
+
+PROJECT_NAME_REGEX = r"^[-a-zA-Z][-a-zA-Z0-9]+$"
+project_name = "{{cookiecutter.project_name}}"
+if not re.match(PROJECT_NAME_REGEX, project_name):
+    print(
+        f"ERROR: The project name {project_name} is not a valid Python module name. Please do not use a _ and use - instead"
+    )
+    # Exit to cancel project
+    sys.exit(1)
+
+PROJECT_SLUG_REGEX = r"^[_a-zA-Z][_a-zA-Z0-9]+$"
+project_slug = "{{cookiecutter.project_slug}}"
+if not re.match(PROJECT_SLUG_REGEX, project_slug):
+    print(
+        f"ERROR: The project slug {project_slug} is not a valid Python module name. Please do not use a - and use _ instead"
+    )
+    # Exit to cancel project
+    sys.exit(1)

cookiecutter_hydro-0.0.1/pyproject.toml

@@ -0,0 +1,122 @@
+[tool.poetry]
+name = "cookiecutter-hydro"
+version = "0.0.1"
+description = "A cookiecutter template for scientific Python projects in the field of hydrology."
+authors = ["Mateusz Zawadzki <zawadzkimat@outlook.com>"]
+repository = "https://github.com/zawadzkim/cookiecutter-hydro"
+documentation = "https://zawadzkim.github.io/cookiecutter-hydro/"
+readme = "README.md"
+keywords = ['cookiecutter', 'template', 'poetry']
+packages = [
+  {include = "cookiecutter_hydro"}
+]
+include = [
+  '{{cookiecutter.project_name}}/**/*',
+  'cookiecutter.json',
+  'hooks/*'
+]
+
+[tool.poetry.dependencies]
+python = "^3.11"
+cookiecutter = "^2.1.1"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^7.2.0"
+pre-commit = "^2.20.0"
+pytest-cookies = "^0.6.1"
+tox = "^3.25.1"
+deptry = "^0.16.2"
+mypy = "^0.991"
+pytest-cov = "^4.0.0"
+
+[tool.poetry.group.docs.dependencies]
+mkdocs = "^1.4.2"
+mkdocs-material = "^8.5.10"
+mkdocstrings-python = "^1.11.1"
+mkdocs-autorefs = "^1.2.0"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.scripts]
+cchydro = 'cookiecutter_hydro.cli:main'
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.coverage.report]
+skip_empty = true
+
+[tool.coverage.run]
+branch = true
+source = ["cookiecutter_hydro"]
+
+[tool.mypy]
+files = ['cookiecutter_hydro']
+disallow_untyped_defs = "True"
+disallow_any_unimported = "True"
+no_implicit_optional = "True"
+check_untyped_defs = "True"
+warn_return_any = "True"
+warn_unused_ignores = "True"
+show_error_codes = "True"
+
+[tool.deptry]
+extend_exclude = [
+  ".+/test_foo.py"
+]
+
+[tool.deptry.per_rule_ignores]
+DEP002 = ["cookiecutter"]
+
+[tool.ruff]
+target-version = "py37"
+line-length = 120
+fix = true
+
+[tool.ruff.lint]
+select = [
+    # flake8-2020
+    "YTT",
+    # flake8-bandit
+    "S",
+    # flake8-bugbear
+    "B",
+    # flake8-builtins
+    "A",
+    # flake8-comprehensions
+    "C4",
+    # flake8-debugger
+    "T10",
+    # flake8-simplify
+    "SIM",
+    # isort
+    "I",
+    # mccabe
+    "C90",
+    # pycodestyle
+    "E", "W",
+    # pyflakes
+    "F",
+    # pygrep-hooks
+    "PGH",
+    # pyupgrade
+    "UP",
+    # ruff
+    "RUF",
+    # tryceratops
+    "TRY",
+]
+ignore = [
+    # LineTooLong
+    "E501",
+    # DoNotAssignLambda
+    "E731",
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["S101", "S603"]
+
+[tool.ruff.lint.isort]
+required-imports = ["from __future__ import annotations"]

cookiecutter_hydro-0.0.1/{{cookiecutter.project_name}}/.devcontainer/devcontainer.json

@@ -0,0 +1,27 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/python
+{
+    "name": "{{cookiecutter.project_name}}",
+    // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+    "image": "mcr.microsoft.com/devcontainers/python:1-3.11-bullseye",
+    "features": {
+        "ghcr.io/devcontainers-contrib/features/poetry:2": {}
+    },
+
+    // Use 'postCreateCommand' to run commands after the container is created.
+    "postCreateCommand": "./.devcontainer/postCreateCommand.sh",
+
+    // Configure tool-specific properties.
+    "customizations": {
+        "vscode": {
+            "extensions": ["ms-python.python", "editorconfig.editorconfig", "yzhang.markdown-all-in-one"],
+            "settings": {
+                "python.testing.pytestArgs": ["tests"],
+                "python.testing.unittestEnabled": false,
+                "python.testing.pytestEnabled": true,
+                "python.defaultInterpreterPath": "/workspaces/{{cookiecutter.project_name}}/.venv/bin/python",
+                "python.testing.pytestPath": "/workspaces/{{cookiecutter.project_name}}/.venv/bin/pytest"
+            }
+        }
+    }
+}

cookiecutter_hydro-0.0.1/{{cookiecutter.project_name}}/.devcontainer/postCreateCommand.sh

@@ -0,0 +1,7 @@
+#! /usr/bin/env bash
+
+# Install Dependencies
+poetry install --with dev
+
+# Install pre-commit hooks
+poetry run pre-commit install --install-hooks

cookiecutter_hydro-0.0.1/{{cookiecutter.project_name}}/.editorconfig

@@ -0,0 +1,5 @@
+max_line_length = 120
+
+[*.json]
+indent_style = space
+indent_size = 4

cookiecutter_hydro-0.0.1/{{cookiecutter.project_name}}/.github/actions/setup-poetry-env/action.yml

@@ -0,0 +1,42 @@
+name: "setup-poetry-env"
+description: "Composite action to setup the Python and poetry environment."
+
+inputs:
+  python-version:
+    required: false
+    description: "The python version to use"
+    default: "3.11"
+
+runs:
+  using: "composite"
+  steps:
+    - name: Set up python
+      uses: actions/setup-python@v5
+      with:
+        python-version: {% raw %}${{ inputs.python-version }}{% endraw %}
+
+    - name: Install Poetry
+      env:
+        POETRY_VERSION: "1.7.1"
+      run: curl -sSL https://install.python-poetry.org | python - -y
+      shell: bash
+
+    - name: Add Poetry to Path
+      run: echo "$HOME/.local/bin" >> $GITHUB_PATH
+      shell: bash
+
+    - name: Configure Poetry virtual environment in project
+      run: poetry config virtualenvs.in-project true
+      shell: bash
+
+    - name: Load cached venv
+      id: cached-poetry-dependencies
+      uses: actions/cache@v4
+      with:
+        path: .venv
+        key: {% raw %}venv-${{ runner.os }}-${{ inputs.python-version }}-${{ hashFiles('poetry.lock') }}{% endraw %}
+
+    - name: Install dependencies
+      if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
+      run: poetry install --no-interaction
+      shell: bash

cookiecutter_hydro-0.0.1/{{cookiecutter.project_name}}/.github/workflows/main.yml

@@ -0,0 +1,50 @@
+name: Main
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+
+jobs:
+  quality:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out
+        uses: actions/checkout@v4
+
+      - uses: actions/cache@v4
+        with:
+          path: ~/.cache/pre-commit
+          key: {% raw %}pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}{% endraw %}
+
+      - name: Set up the environment
+        uses: ./.github/actions/setup-poetry-env
+
+      - name: Run checks
+        run: make check
+
+  tests-and-type-check:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: "3.11"
+      fail-fast: false
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - name: Check out
+        uses: actions/checkout@v4
+
+      - name: Set up the environment
+        uses: ./.github/actions/setup-poetry-env
+        with:
+          python-version: {% raw %}${{ matrix.python-version }}{% endraw %}
+
+      - name: Run tests
+        run: poetry run pytest tests
+
+      - name: Check typing
+        run: poetry run mypy

cookiecutter_hydro-0.0.1/{{cookiecutter.project_name}}/.gitignore

@@ -0,0 +1,167 @@
+docs/source
+
+# From https://raw.githubusercontent.com/github/gitignore/main/Python.gitignore
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# Vscode config files
+.vscode/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

cookiecutter_hydro-0.0.1/{{cookiecutter.project_name}}/.pre-commit-config.yaml

@@ -0,0 +1,22 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: "v4.4.0"
+    hooks:
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: "v0.5.2"
+    hooks:
+      - id: ruff
+        args: [--exit-non-zero-on-fix]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: "v3.0.3"
+    hooks:
+      - id: prettier

cookiecutter_hydro-0.0.1/{{cookiecutter.project_name}}/Dockerfile

@@ -0,0 +1,21 @@
+# syntax=docker/dockerfile:1
+
+FROM python:3.9-slim-buster
+
+ENV POETRY_VERSION=1.4 \
+    POETRY_VIRTUALENVS_CREATE=false
+
+# Install poetry
+RUN pip install "poetry==$POETRY_VERSION"
+
+# Copy only requirements to cache them in docker layer
+WORKDIR /code
+COPY poetry.lock pyproject.toml /code/
+
+# Project initialization:
+RUN poetry install --no-interaction --no-ansi --no-root --no-dev
+
+# Copy Python code to the Docker image
+COPY {{cookiecutter.project_slug}} /code/{{cookiecutter.project_slug}}/
+
+CMD [ "python", "{{cookiecutter.project_slug}}/src/foo.py"]

cookiecutter_hydro-0.0.1/{{cookiecutter.project_name}}/LICENSE

@@ -0,0 +1,111 @@
+{% if cookiecutter.open_source_license == 'MIT license' -%}
+MIT License
+
+Copyright (c) {% now 'local', '%Y' %}, {{ cookiecutter.author }}
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+{% elif cookiecutter.open_source_license == 'BSD license' %}
+
+BSD License
+
+Copyright (c) {% now 'local', '%Y' %}, {{ cookiecutter.author }}
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this
+  list of conditions and the following disclaimer in the documentation and/or
+  other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from this
+  software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+OF THE POSSIBILITY OF SUCH DAMAGE.
+{% elif cookiecutter.open_source_license == 'ISC license' -%}
+ISC License
+
+Copyright (c) {% now 'local', '%Y' %}, {{ cookiecutter.author }}
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+{% elif cookiecutter.open_source_license == 'Apache Software License 2.0' -%}
+Apache Software License 2.0
+
+Copyright (c) {% now 'local', '%Y' %}, {{ cookiecutter.author }}
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+{% elif cookiecutter.open_source_license == 'GNU General Public License v3' -%}
+GNU GENERAL PUBLIC LICENSE
+                      Version 3, 29 June 2007
+
+    {{ cookiecutter.project_description }}
+    Copyright (C) {% now 'local', '%Y' %}  {{ cookiecutter.author }}
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<http://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
+{% endif %}

cookiecutter_hydro-0.0.1/{{cookiecutter.project_name}}/Makefile

@@ -0,0 +1,39 @@
+.PHONY: install
+install: ## Install the poetry environment and install the pre-commit hooks
+	@echo "🚀 Creating virtual environment using pyenv and poetry"
+	@poetry install
+	@ poetry run pre-commit install
+	@poetry shell
+
+.PHONY: check
+check: ## Run code quality tools.
+	@echo "🚀 Checking Poetry lock file consistency with 'pyproject.toml': Running poetry check --lock"
+	@poetry check --lock
+	@echo "🚀 Linting code: Running pre-commit"
+	@poetry run pre-commit run -a
+	@echo "🚀 Static type checking: Running mypy"
+	@poetry run mypy
+{%- if cookiecutter.deptry == 'y' %}
+	@echo "🚀 Checking for obsolete dependencies: Running deptry"
+	@poetry run deptry .
+{%- endif %}
+
+.PHONY: test
+test: ## Test the code with pytest
+	@echo "🚀 Testing code: Running pytest"
+	@poetry run pytest --doctest-modules
+
+.PHONY: build
+build: clean-build ## Build wheel file using poetry
+	@echo "🚀 Creating wheel file"
+	@poetry build
+
+.PHONY: clean-build
+clean-build: ## clean build artifacts
+	@rm -rf dist
+
+.PHONY: help
+help:
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
+
+.DEFAULT_GOAL := help

cookiecutter_hydro-0.0.1/{{cookiecutter.project_name}}/README.md

@@ -0,0 +1,10 @@
+# {{cookiecutter.project_name}}
+
+[![Commit activity](https://img.shields.io/github/commit-activity/m/{{cookiecutter.author_github_handle}}/{{cookiecutter.project_name}})](https://img.shields.io/github/commit-activity/m/{{cookiecutter.author_github_handle}}/{{cookiecutter.project_name}})
+[![License](https://img.shields.io/github/license/{{cookiecutter.author_github_handle}}/{{cookiecutter.project_name}})](https://img.shields.io/github/license/{{cookiecutter.author_github_handle}}/{{cookiecutter.project_name}})
+
+{{cookiecutter.project_description}}
+
+- **Github repository**: <https://github.com/{{cookiecutter.author_github_handle}}/{{cookiecutter.project_name}}/>
+
+## My Hydrological Anlanysis repo

cookiecutter_hydro-0.0.1/{{cookiecutter.project_name}}/poetry.toml

@@ -0,0 +1,2 @@
+[virtualenvs]
+in-project = true

cookiecutter_hydro-0.0.1/{{cookiecutter.project_name}}/pyproject.toml

@@ -0,0 +1,100 @@
+[tool.poetry]
+name = "{{cookiecutter.project_slug}}"
+version = "0.0.1"
+description = "{{cookiecutter.project_description}}"
+authors = ["{{cookiecutter.author}} <{{cookiecutter.email}}>"]
+repository = "https://github.com/{{cookiecutter.author_github_handle}}/{{cookiecutter.project_name}}"
+documentation = "https://{{cookiecutter.author_github_handle}}.github.io/{{cookiecutter.project_name}}/"
+readme = "README.md"
+packages = [
+  {include = "{{cookiecutter.project_slug}}"}
+]
+
+[tool.poetry.dependencies]
+python = "^3.11"
+{% if cookiecutter.model == 'flopy' -%}
+flopy = "^3.8"
+{% elif cookiecutter.model == 'swap' -%}
+pyswap = "*"
+{% elif cookiecutter.model == 'pastas' -%}
+pastas = "^1.7"
+{% endif -%}
+{% if cookiecutter.gensor == 'y' -%}
+gensor = "*"
+{% endif -%}
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^7.2.0"
+{% if cookiecutter.deptry == 'y' -%}
+deptry = "^0.16.2"
+{% endif -%}
+mypy = "^1.5.1"
+pre-commit = "^3.4.0"
+tox = "^4.11.1"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.mypy]
+files = ["{{cookiecutter.project_slug}}"]
+disallow_untyped_defs = "True"
+disallow_any_unimported = "True"
+no_implicit_optional = "True"
+check_untyped_defs = "True"
+warn_return_any = "True"
+warn_unused_ignores = "True"
+show_error_codes = "True"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.ruff]
+target-version = "py39"
+line-length = 120
+fix = true
+select = [
+    # flake8-2020
+    "YTT",
+    # flake8-bandit
+    "S",
+    # flake8-bugbear
+    "B",
+    # flake8-builtins
+    "A",
+    # flake8-comprehensions
+    "C4",
+    # flake8-debugger
+    "T10",
+    # flake8-simplify
+    "SIM",
+    # isort
+    "I",
+    # mccabe
+    "C90",
+    # pycodestyle
+    "E", "W",
+    # pyflakes
+    "F",
+    # pygrep-hooks
+    "PGH",
+    # pyupgrade
+    "UP",
+    # ruff
+    "RUF",
+    # tryceratops
+    "TRY",
+]
+ignore = [
+    # LineTooLong
+    "E501",
+    # DoNotAssignLambda
+    "E731",
+]
+
+[tool.ruff.format]
+preview = true
+
+
+[tool.ruff.per-file-ignores]
+"tests/*" = ["S101"]

cookiecutter_hydro-0.0.1/{{cookiecutter.project_name}}/tests/test_foo.py

@@ -0,0 +1,5 @@
+from {{cookiecutter.project_slug}}.src.foo import foo
+
+
+def test_foo():
+    assert foo("foo") == "foo"

cookiecutter_hydro-0.0.1/{{cookiecutter.project_name}}/tox.ini

@@ -0,0 +1,18 @@
+[tox]
+skipsdist = true
+envlist = py38, py39, py310, py311
+
+[gh-actions]
+python =
+    3.8: py38
+    3.9: py39
+    3.10: py310
+    3.11: py311
+
+[testenv]
+passenv = PYTHON_VERSION
+allowlist_externals = poetry
+commands =
+    poetry install -v
+    pytest --doctest-modules tests --cov --cov-config=pyproject.toml --cov-report=xml
+    mypy

cookiecutter_hydro-0.0.1/{{cookiecutter.project_name}}/{{cookiecutter.project_slug}}/data/README.md

@@ -0,0 +1,14 @@
+## Data module
+
+This modules helps to structure the data for the models. General use guidelines are as follows. In the root of the data module there are three folders:
+
+- boundaries: These are boundary conditions for the model
+- layers: layer surfaces and their properties
+- observations: observation data used, e.g., for model calibration
+
+Additionally, each folder has two subdirectories for storing raw and processed data:
+
+- raw: raw (e.g., unclipped, unfiltered) data
+- processed: output data which should be included in the repository and for other people to use to reproduce our results. These files should be clearly named, indluding versioning, etc. Remember that the files put in GitHub should not be too big. If you have big data, perhaps cloud storage like Amazon S3 should be considered.
+
+The structure may appear complex, but in the end the files in each of these directories are imported directly into your script or notebook with `.` notation (from data.boundaries.processed import ghb_layer1)

cookiecutter_hydro-0.0.1/{{cookiecutter.project_name}}/{{cookiecutter.project_slug}}/data/__init__.py

@@ -0,0 +1,13 @@
+"""Path for the data:
+
+Attributes:
+
+    data (Traversable): base path of the data directory.
+
+"""
+
+from importlib import resources
+from importlib.abc import Traversable
+
+data: Traversable = resources.files(__name__)
+"""The whole directory of test groundwater sensor data."""

cookiecutter_hydro-0.0.1/{{cookiecutter.project_name}}/{{cookiecutter.project_slug}}/data/boundaries/__init__.py

@@ -0,0 +1,20 @@
+"""Path for the data:
+
+Attributes:
+
+    boundaries (Traversable): base path of the boundary condition directory.
+
+"""
+
+from importlib import resources
+from importlib.abc import Traversable
+
+boundaries: Traversable = resources.files(__name__)
+"""The whole directory of test groundwater sensor data."""
+
+processed: Traversable = boundaries.joinpath("processed")
+"""Processed boundary condition data."""
+
+
+raw: Traversable = boundaries.joinpath("raw")
+"""Raw boundary condition data."""

cookiecutter_hydro-0.0.1/{{cookiecutter.project_name}}/{{cookiecutter.project_slug}}/notebooks/README.md

@@ -0,0 +1,9 @@
+# Jupyter notebooks
+
+My favourite way to work on data hydrological models is to use jupyter notebooks. They give an amazing platform to build the models and document them at the same time. It is also good to split the workflows into multiple notebooks to avoid creating monstrous, unreadable files. As pointed out in [this article](https://www.svds.com/jupyter-notebook-best-practices-for-data-science/), it is also increadibly important to keep a consistent way of naming your notebooks. This structure makes a lot of sense:
+
+[ISO 8601 date]-[DS-initials]-[2-4 word description].ipynb
+
+e.g.: 2015-06-28-jw-initial-data-clean.ipynb
+
+This allows you to search for notebooks by date or topic.

cookiecutter_hydro-0.0.1/{{cookiecutter.project_name}}/{{cookiecutter.project_slug}}/output/__init__.py

@@ -0,0 +1,13 @@
+"""Path for the data:
+
+Attributes:
+
+    output (Traversable): base path of the data directory.
+
+"""
+
+from importlib import resources
+from importlib.abc import Traversable
+
+output: Traversable = resources.files(__name__)
+"""All files in the output directory."""

cookiecutter_hydro-0.0.1/{{cookiecutter.project_name}}/{{cookiecutter.project_slug}}/src/foo.py

@@ -0,0 +1,17 @@
+def foo(bar: str) -> str:
+    """Summary line.
+
+    Extended description of function.
+
+    Parameters:
+        bar (str): Description of input argument.
+
+    Returns:
+        Description of return value
+    """
+
+    return bar
+
+
+if __name__ == "__main__":  # pragma: no cover
+    pass