diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..56adc17 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,34 @@ +--- + +name: Bug Report +about: Create a bug report to help us improve cookiecutter-pytask +title: "BUG:" +labels: "bug" + +--- + +- [ ] I have checked that this issue has not already been reported. + +- [ ] I have confirmed this bug exists on the latest version of cookiecutter-pytask. + +- [ ] (optional) I have confirmed this bug exists on the `main` branch of + cookiecutter-pytask. + +--- + +**Note**: Please read [this +guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) detailing +how to provide the necessary information for us to reproduce your bug. + +#### Code Sample, a copy-pastable example + +```python +# Your code here +``` + +#### Problem description + +Explain **why** the current behaviour is a problem and why the expected output is a +better solution. + +#### Expected Output diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 0000000..b9f399b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,20 @@ +--- + +name: Documentation Improvement +about: Report wrong or missing documentation +title: "DOC:" +labels: "documentation" + +--- + +#### Location of the documentation + +Provide the location of the documentation, e.g. an URL to a section of the readme. + +#### Documentation problem + +Provide a description of what documentation you believe needs to be fixed/improved. + +#### Suggested fix for documentation + +Explain the suggested fix and **why** it's better than the existing documentation. diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md new file mode 100644 index 0000000..3d450e7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.md @@ -0,0 +1,34 @@ +--- + +name: Enhancement +about: Suggest an idea for cookiecutter-pytask +title: "ENH:" +labels: "enhancement" + +--- + +#### Is your feature request related to a problem? + +Provide a description of what the problem is, e.g. "I wish I could use +cookiecutter-pytask to do [...]". + +#### Describe the solution you'd like + +Provide a description of the feature request and how it might be implemented. + +#### API breaking implications + +Provide a description of how this feature will affect the API. + +#### Describe alternatives you've considered + +Provide a description of any alternative solutions or features you've considered. + +#### Additional context + +Add any other context, code examples, or references to existing implementations about +the feature request here. + +```python +# Your code here, if applicable +``` diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000..7bcfa8c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,18 @@ +--- + +name: Submit Question +about: Ask a general question about cookiecutter-pytask +title: "QST:" +labels: "question" + +--- + +#### Question about pytask + +**Note**: If you'd still like to submit a question, please read [this guide]( +https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) detailing how to +provide the necessary information for us to reproduce your question. + +```python +# Your code here, if applicable +``` diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..1414294 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,9 @@ +#### Changes + +Provide a description and/or bullet points to describe the changes in this PR. + +#### Todo + +- [ ] Reference issues which can be closed due to this PR with "Closes #x". +- [ ] Review whether the documentation needs to be updated. +- [ ] Document PR in CHANGES.rst. diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 0000000..7757402 --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,84 @@ +name: main + +on: + push: + branches: + - main + pull_request: + branches: + - '*' + +jobs: + + run-tests: + + name: Run tests for ${{ matrix.os }} on ${{ matrix.python-version }} + runs-on: ${{ matrix.os }} + env: + CONDA_EXE: mamba + + strategy: + fail-fast: false + matrix: + os: ['ubuntu-latest', 'macos-latest', 'windows-latest'] + python-version: ['3.7', '3.8', '3.9'] + + steps: + - uses: actions/checkout@v2 + - uses: conda-incubator/setup-miniconda@v2 + with: + auto-update-conda: true + python-version: ${{ matrix.python-version }} + + - name: Install core dependencies. + shell: bash -l {0} + run: conda install -c conda-forge tox-conda coverage + + # Unit, integration, and end-to-end tests. + + # - name: Run unit tests and doctests. + # shell: bash -l {0} + # run: tox -e pytest -- "\{\{cookiecutter.project_slug\}\}" tests -m "unit or (not integration and not end_to_end)" --cov=./ --cov-report=xml -n auto + + # - name: Upload coverage report for unit tests and doctests. + # if: runner.os == 'Linux' && matrix.python-version == '3.8' + # shell: bash -l {0} + # run: bash <(curl -s https://codecov.io/bash) -F unit -c + + # - name: Run integration tests. + # shell: bash -l {0} + # run: tox -e pytest -- "\{\{cookiecutter.project_slug\}\}" tests -m integration --cov=./ --cov-report=xml -n auto + + # - name: Upload coverage reports of integration tests. + # if: runner.os == 'Linux' && matrix.python-version == '3.8' + # shell: bash -l {0} + # run: bash <(curl -s https://codecov.io/bash) -F integration -c + + - name: Run end-to-end tests. + shell: bash -l {0} + run: tox -e pytest -- "\{\{cookiecutter.project_slug\}\}" tests -m end_to_end --cov=./ --cov-report=xml -n auto + + - name: Upload coverage reports of end-to-end tests. + if: runner.os == 'Linux' && matrix.python-version == '3.8' + shell: bash -l {0} + run: bash <(curl -s https://codecov.io/bash) -F end_to_end -c + + + docs: + + name: Run documentation. + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + - uses: conda-incubator/setup-miniconda@v2 + with: + auto-update-conda: true + + - name: Install core dependencies. + shell: bash -l {0} + run: conda install -c conda-forge tox-conda + + - name: Build docs + shell: bash -l {0} + run: tox -e sphinx diff --git a/.gitignore b/.gitignore index b6e4761..8e3b795 100644 --- a/.gitignore +++ b/.gitignore @@ -69,7 +69,7 @@ instance/ .scrapy # Sphinx documentation -docs/_build/ +docs/build/ # PyBuilder target/ @@ -127,3 +127,26 @@ dmypy.json # Pyre type checker .pyre/ + +# Files +.coverage +coverage.* + +# Folders +.idea +.ipynb_checkpoints +.tox +.vscode +_build +__pycache__ +_generated + +*.egg-info +.eggs + +.pytask.sqlite3 + +build +dist + +version.py diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..6cb1be8 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,106 @@ +repos: +- repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.0.1 + hooks: + - id: check-added-large-files + args: ['--maxkb=25'] + - id: check-case-conflict + - id: check-merge-conflict + - id: check-vcs-permalinks + - id: check-yaml + exclude: "{{cookiecutter.project_slug}}/environment.yml" + - id: debug-statements + - id: end-of-file-fixer + - id: fix-byte-order-marker + - id: forbid-new-submodules + - id: mixed-line-ending + - id: no-commit-to-branch + args: [--branch, main] + - id: trailing-whitespace +- repo: https://github.com/pre-commit/pygrep-hooks + rev: v1.9.0 + hooks: + - id: python-check-blanket-noqa + - id: python-check-mock-methods + - id: python-no-eval + - id: python-no-log-warn + - id: python-use-type-annotations + - id: rst-backticks + - id: rst-directive-colons + - id: rst-inline-touching-normal + - id: text-unicode-replacement-char +- repo: https://github.com/asottile/pyupgrade + rev: v2.29.1 + hooks: + - id: pyupgrade + args: [--py36-plus] +- repo: https://github.com/asottile/reorder_python_imports + rev: v2.6.0 + hooks: + - id: reorder-python-imports +- repo: https://github.com/asottile/setup-cfg-fmt + rev: v1.20.0 + hooks: + - id: setup-cfg-fmt +- repo: https://github.com/psf/black + rev: 21.12b0 + hooks: + - id: black +- repo: https://github.com/asottile/blacken-docs + rev: v1.12.0 + hooks: + - id: blacken-docs + additional_dependencies: [black] +- repo: https://github.com/PyCQA/flake8 + rev: 4.0.1 + hooks: + - id: flake8 + additional_dependencies: [ + flake8-alfred, + flake8-bugbear, + flake8-builtins, + flake8-comprehensions, + flake8-docstrings, + flake8-eradicate, + flake8-print, + flake8-pytest-style, + flake8-todo, + flake8-typing-imports, + flake8-unused-arguments, + pep8-naming, + pydocstyle, + Pygments, + ] +- repo: https://github.com/PyCQA/doc8 + rev: 0.10.1 + hooks: + - id: doc8 +- repo: https://github.com/econchick/interrogate + rev: 1.5.0 + hooks: + - id: interrogate + args: [-v, --fail-under=40, "{{cookiecutter.project_slug}}"] + pass_filenames: false +- repo: https://github.com/codespell-project/codespell + rev: v2.1.0 + hooks: + - id: codespell +- repo: https://github.com/guilatrova/tryceratops + rev: v1.0.0 + hooks: + - id: tryceratops +- repo: https://github.com/pre-commit/mirrors-mypy + rev: 'v0.910-1' + hooks: + - id: mypy + args: [ + --no-strict-optional, + --ignore-missing-imports, + ] + pass_filenames: false + language_version: "3.9" +- repo: meta + hooks: + - id: check-hooks-apply + - id: check-useless-excludes + # - id: identity # Prints all files passed to pre-commits. Debugging. diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..5e35e9f --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,10 @@ +version: 2 + +build: + image: latest + +python: + version: 3.8 + +conda: + environment: docs/rtd_environment.yml diff --git a/CHANGES.rst b/CHANGES.rst new file mode 100644 index 0000000..3e53706 --- /dev/null +++ b/CHANGES.rst @@ -0,0 +1,11 @@ +Changes +======= + +This is a record of all past cookiecutter-pytask releases and what went into them in +reverse chronological order. + + +1.0.0 - 2021-12-22 +------------------ + +- :gh:`1` creates first release of a minimal cookiecutter template for a pytask project. diff --git a/LICENSE b/LICENSE index ae6c044..b0c5075 100644 --- a/LICENSE +++ b/LICENSE @@ -2,20 +2,19 @@ MIT License Copyright (c) 2021 Tobias Raabe -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: +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 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. +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. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..93993fb --- /dev/null +++ b/README.rst @@ -0,0 +1,56 @@ +cookiecutter-pytask +=================== + +.. image:: https://img.shields.io/github/license/pytask-dev/cookiecutter-pytask + :alt: MIT license + :target: https://pypi.org/project/pytask + +.. image:: https://readthedocs.org/projects/cookiecutter-pytask/badge/?version=latest + :target: https://cookiecutter-pytask.readthedocs.io/en/latest + +.. image:: https://img.shields.io/github/workflow/status/pytask-dev/cookiecutter-pytask/main/main + :target: https://github.com/pytask-dev/cookiecutter-pytask/actions?query=branch%3Amain + +.. image:: https://codecov.io/gh/pytask-dev/cookiecutter-pytask/branch/main/graph/badge.svg + :target: https://codecov.io/gh/pytask-dev/cookiecutter-pytask + +.. image:: https://results.pre-commit.ci/badge/github/pytask-dev/cookiecutter-pytask/main.svg + :target: https://results.pre-commit.ci/latest/github/pytask-dev/cookiecutter-pytask/main + :alt: pre-commit.ci status + +.. image:: https://img.shields.io/badge/code%20style-black-000000.svg + :target: https://github.com/psf/black + + +This repository contains a minimal cookiecutter template for a project with `pytask +`_ . + + +Usage +----- + +First, install cookiecutter. + +.. code-block:: console + + $ pip install cookiecutter + + $ conda install -c conda-forge cookiecutter + +Then, set up the template with + +.. code-block:: console + + $ cookiecutter https://github.com/pytask-dev/cookiecutter-pytask + + +FAQ +--- + +Q: Why are the source files nested in ``src/``? + +A: This is called the src layout and the advantages are discussed in this `article by +Hynek Schlawack `_. + +Although the article discusses the src layout in terms of Python packages, it is also +beneficial to structure a project the same way. diff --git a/codecov.yml b/codecov.yml new file mode 100644 index 0000000..4892c14 --- /dev/null +++ b/codecov.yml @@ -0,0 +1,27 @@ +codecov: + branch: main + +coverage: + precision: 2 + round: down + range: 80...100 + status: + project: + default: + threshold: 1% + unit: + threshold: 1% + flags: + - unit + integration: + threshold: 1% + flags: + - integration + end_to_end: + threshold: 1% + flags: + - end_to_end + +ignore: + - ".tox/**/*" + - "setup.py" diff --git a/cookiecutter.json b/cookiecutter.json new file mode 100644 index 0000000..dc7291c --- /dev/null +++ b/cookiecutter.json @@ -0,0 +1,26 @@ +{ + "author": "Arianna W. Rosenbluth", + "email": "{{ cookiecutter.author.lower().replace(' ', '') }}@mail.edu", + "project_name": "Reproducible Research Template", + "project_slug": "{{ cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_') }}", + "project_description": "A project for ...", + "github_username": "{{ cookiecutter.author.lower().replace(' ', '') }}", + "github_email": "{{ cookiecutter.email }}", + "version": "0.0.1", + "python_version": "3.8", + "add_tox": ["yes", "no"], + "add_github_actions": ["yes", "no"], + "add_readthedocs": ["yes", "no"], + "add_codecov": ["yes", "no"], + "create_changelog": ["yes", "no"], + "open_source_license": [ + "MIT", "BSD", "ISC", "Apache Software License 2.0", + "GNU General Public License v3", "Not open source" + ], + "make_initial_commit": ["no", "yes"], + "conda_environment_name": "{{ cookiecutter.project_slug }}", + "create_conda_environment_at_finish": ["no", "yes"], + "_copy_without_render": [ + ".github/workflows/main.yml" + ] +} diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d0c3cbf --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..061f32f --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.https://www.sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/docs/rtd_environment.yml b/docs/rtd_environment.yml new file mode 100644 index 0000000..a0ccb12 --- /dev/null +++ b/docs/rtd_environment.yml @@ -0,0 +1,22 @@ +channels: + - conda-forge + - nodefaults + +dependencies: + - python >= 3.7 + - pip + - setuptools_scm + - toml + + # Documentation + - furo + - ipython + - nbsphinx + - sphinx + - sphinx-autoapi + - sphinx-click + - sphinx-copybutton + - sphinx-panels + + - pip: + - -e .. diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..b48c903 --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,45 @@ +"""Configuration file for the Sphinx documentation builder. + +This file only contains a selection of the most common options. For a full list see the +documentation: https://www.sphinx-doc.org/en/master/usage/configuration.html + +""" +from importlib.metadata import version + +# -- Project information ----------------------------------------------------- + +project = "cookiecutter-pytask" +author = "Tobias Raabe" +copyright = f"2021, {author}" # noqa: A001 + +# The version, including alpha/beta/rc tags, but not commit hash and datestamps +release = version("cookiecutter-pytask") +# The short X.Y version. +version = ".".join(release.split(".")[:2]) + + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be extensions coming +# with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = [] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ["_templates"] + +# List of patterns, relative to source directory, that match files and directories to +# ignore when looking for source files. This pattern also affects html_static_path and +# html_extra_path. +exclude_patterns = [] + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for a list of +# builtin themes. +html_theme = "furo" + +# Add any paths that contain custom static files (such as style sheets) here, relative +# to this directory. They are copied after the builtin static files, so a file named +# "default.css" will overwrite the builtin "default.css". +html_static_path = ["_static"] diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..59dbd0f --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,4 @@ +Welcome to cookiecutter-pytask's documentation! +=============================================== + +.. include:: ../../README.rst diff --git a/environment.yml b/environment.yml new file mode 100644 index 0000000..577fb20 --- /dev/null +++ b/environment.yml @@ -0,0 +1,34 @@ +name: cp + +channels: + - conda-forge + - nodefaults + +dependencies: + - python >=3.7 + - pip + - setuptools_scm + - toml + + # Package dependencies + - cookiecutter + - pytask + + # Misc + - black + - mypy + - pre-commit + - pytest + - pytest-cookies + - pytest-cov + - pytest-xdist + - tox-conda + + # Documentation + - furo + - nbsphinx + - sphinx + - sphinx-autoapi + - sphinx-click + - sphinx-copybutton + - sphinx-panels diff --git a/hooks/post_gen_project.py b/hooks/post_gen_project.py new file mode 100644 index 0000000..e9cf9bf --- /dev/null +++ b/hooks/post_gen_project.py @@ -0,0 +1,90 @@ +"""This module contains hooks which are executed after the template is rendered.""" +import shutil +import subprocess +import warnings +from pathlib import Path + + +def remove_file(*filepath): + """Remove a file.""" + try: + Path(*filepath).unlink() + except FileNotFoundError: + pass + + +def remove_directory(*filepath): + """Remove a directory.""" + try: + path = Path(*filepath) + shutil.rmtree(path) + except FileNotFoundError: + pass + + +def main(): + """Apply post generation hooks.""" + project_path = Path.cwd() + + if "{{ cookiecutter.create_changelog }}" == "no": + remove_file(project_path, "CHANGES.rst") + + if "{{ cookiecutter.open_source_license }}" == "Not open source": + remove_file(project_path, "LICENSE") + + if "{{ cookiecutter.add_tox }}" == "no": + remove_directory(project_path, ".github", "workflows") + remove_file("tox.ini") + + if "{{ cookiecutter.add_github_actions }}" == "no": + remove_directory(project_path, ".github", "workflows") + + if "{{ cookiecutter.add_readthedocs }}" == "no": + remove_file(project_path, ".readthedocs.yaml") + + if "{{ cookiecutter.make_initial_commit }}" == "yes": + # Create an initial commit on the main branch and restore global default name. + p = subprocess.run( + ("git", "config", "init.defaultBranch"), check=True, capture_output=True + ) + old_branch_default = p.stdout.decode().strip() + subprocess.run( + ("git", "config", "--global", "init.defaultBranch", "main"), check=True + ) + subprocess.run(("git", "init"), check=True, capture_output=True) + subprocess.run( + ("git", "config", "user.name", "'{{ cookiecutter.github_username }}'"), + check=True, + ) + subprocess.run( + ("git", "config", "user.email", "'{{ cookiecutter.github_email }}'"), + check=True, + ) + subprocess.run(("git", "add", "."), check=True) + subprocess.run( + ("git", "commit", "-m", "'Initial commit.'"), + check=True, + capture_output=True, + ) + subprocess.run( + ("git", "config", "--global", "init.defaultBranch", old_branch_default), + check=True, + ) + + if "{{ cookiecutter.create_conda_environment_at_finish }}" == "yes": + if shutil.which("mamba") is not None: + conda_exe = shutil.which("mamba") + else: + conda_exe = shutil.which("conda") + + if conda_exe is None: + warnings.warn( + "conda environment could not be created since no conda or mamba " + "executable was found." + ) + else: + subprocess.run(("conda", "env", "create"), check=True) + + +if __name__ == "__main__": + main() diff --git a/hooks/pre_gen_project.py b/hooks/pre_gen_project.py new file mode 100644 index 0000000..1125117 --- /dev/null +++ b/hooks/pre_gen_project.py @@ -0,0 +1,40 @@ +"""This module contains hooks which are executed before the template is rendered.""" +import re + +MODULE_REGEX = r"^[-_a-zA-Z0-9]*$" +ENVIRON_REGEX = r"^[-_a-zA-Z0-9]*$" +PYTHONVERSION_REGEX = r"^(3)\.[6-9]$" + +EXCEPTION_MSG_MODULE_NAME = """ +ERROR: The project slug ({module_name}) is not a valid Python module name. +Please do not use anything other than letters, numbers, underscores '_', +and minus signs '-'. +""" + +EXCEPTION_MSG_ENVIRON_NAME = """ +ERROR: The project slug ({environment_name}) is not a valid conda environment name. +Please do not use anything other than letters, numbers, underscores '_', +and minus signs '-'. +""" + + +def main(): + """Apply pre-generation hooks.""" + module_name = "{{ cookiecutter.project_slug}}" + + if not re.match(MODULE_REGEX, module_name): + raise ValueError(EXCEPTION_MSG_MODULE_NAME.format(module_name)) + + environment_name = "{{ cookiecutter.conda_environment_name }}" + + if not re.match(ENVIRON_REGEX, environment_name): + raise ValueError(EXCEPTION_MSG_ENVIRON_NAME.format(environment_name)) + + python_version = "{{ cookiecutter.python_version }}" + + if not re.match(PYTHONVERSION_REGEX, python_version): + raise ValueError("ERROR: The python version must be >= 3.6") # noqa: TC003 + + +if __name__ == "__main__": + main() diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..71aabb6 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,27 @@ +[build-system] +requires = ["setuptools>=45", "wheel", "setuptools_scm[toml]>=6.0"] + + +[tool.setuptools_scm] +write_to = "version.py" + + +[tool.tryceratops] +ignore = ["TC003"] + + +[tool.mypy] +files = ["{{cookiecutter.project_slug}}", "tests"] +check_untyped_defs = true +disallow_any_generics = true +disallow_incomplete_defs = true +disallow_untyped_defs = true +no_implicit_optional = true +warn_redundant_casts = true +warn_unused_ignores = true + + +[[tool.mypy.overrides]] +module = "tests.*" +disallow_untyped_defs = false +ignore_errors = true diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..3d4e4cf --- /dev/null +++ b/setup.cfg @@ -0,0 +1,39 @@ +[metadata] +name = cookiecutter_pytask +description = A minimal template for projects with pytask. +long_description = file: README.rst +long_description_content_type = text/x-rst +url = https://cookiecutter-pytask.readthedocs.io/en/latest +author = Tobias Raabe +author_email = raabe@posteo.de +license = MIT +license_file = LICENSE +platforms = unix, linux, osx, cygwin, win32 +classifiers = + Development Status :: 3 - Alpha + Intended Audience :: Science/Research + License :: OSI Approved :: MIT License + Operating System :: MacOS :: MacOS X + Operating System :: Microsoft :: Windows + Operating System :: POSIX + Programming Language :: Python :: 3 + Programming Language :: Python :: 3 :: Only + Programming Language :: Python :: 3.6 + Programming Language :: Python :: 3.7 + Programming Language :: Python :: 3.8 + Programming Language :: Python :: 3.9 + Programming Language :: Python :: 3.10 + Topic :: Scientific/Engineering +project_urls = + Changelog = https://cookiecutter-pytask.readthedocs.io/en/latest/changes.html + Documentation = https://cookiecutter-pytask.readthedocs.io/en/latest + Github = https://github.com/pytask-dev/cookiecutter-pytask + Tracker = https://github.com/pytask-dev/cookiecutter-pytask/issues + +[options] +python_requires = >=3.6 +zip_safe = False + +[check-manifest] +ignore = + version.py diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..26e08e4 --- /dev/null +++ b/setup.py @@ -0,0 +1,5 @@ +from setuptools import setup + + +if __name__ == "__main__": + setup() diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000..6cc8cb4 --- /dev/null +++ b/tests/__init__.py @@ -0,0 +1 @@ +"""This file is necessary to apply custom mypy configurations for the tests.""" diff --git a/tests/test_cookie.py b/tests/test_cookie.py new file mode 100644 index 0000000..464b64c --- /dev/null +++ b/tests/test_cookie.py @@ -0,0 +1,110 @@ +import os +import subprocess +import sys + +import pytest + + +@pytest.mark.end_to_end +def test_bake_project(cookies): + major, minor = sys.version_info[:2] + python_version = f"{major}.{minor}" + + result = cookies.bake( + extra_context={"project_slug": "helloworld", "python_version": python_version} + ) + + assert result.exit_code == 0 + assert result.exception is None + assert result.project_path.name == "helloworld" + assert result.project_path.is_dir() + + +@pytest.mark.end_to_end +def test_remove_readthedocs(cookies): + result = cookies.bake(extra_context={"add_readthedocs": "no"}) + + rtd_config = result.project_path.joinpath(".readthedocs.yaml") + readme = result.project_path.joinpath("README.rst").read_text() + + assert result.exit_code == 0 + assert result.exception is None + + assert not rtd_config.exists() + assert "readthedocs" not in readme + + +@pytest.mark.end_to_end +def test_remove_github_actions(cookies): + result = cookies.bake(extra_context={"add_github_actions": "no"}) + + ga_config = result.project_path.joinpath(".github", "workflows", "main.yml") + readme = result.project_path.joinpath("README.rst").read_text() + + assert result.exit_code == 0 + assert result.exception is None + + assert not ga_config.exists() + assert "github/workflow/status" not in readme + + +@pytest.mark.end_to_end +def test_remove_tox(cookies): + result = cookies.bake(extra_context={"add_tox": "no"}) + + ga_config = result.project_path.joinpath(".github", "workflows", "main.yml") + tox = result.project_path.joinpath("tox.ini") + + assert result.exit_code == 0 + assert result.exception is None + + assert not ga_config.exists() + assert not tox.exists() + + +@pytest.mark.end_to_end +def test_remove_license(cookies): + result = cookies.bake(extra_context={"open_source_license": "Not open source"}) + + license_ = result.project_path.joinpath("LICENSE") + + assert result.exit_code == 0 + assert result.exception is None + + assert not license_.exists() + + +@pytest.mark.end_to_end +def test_remove_changes(cookies): + result = cookies.bake(extra_context={"create_changelog": "no"}) + + changes = result.project_path.joinpath("CHANGES.rst") + + assert result.exit_code == 0 + assert result.exception is None + + assert not changes.exists() + + +@pytest.mark.end_to_end +@pytest.mark.skipif( + os.environ.get("CI", "false") == "false", + reason="Conda environment is only created on CI service.", +) +def test_check_conda_environment_creation_and_run_all_checks(cookies): + """Test that the conda environment is created and pre-commit passes.""" + result = cookies.bake( + extra_context={ + "conda_environment_name": "__test__", + "create_conda_environment_at_finish": "yes", + } + ) + + assert result.exit_code == 0 + assert result.exception is None + + subprocess.run( + ("conda", "run", "-n", "__test__", "pre-commit", "run", "--all-files"), + cwd=result.project_path, + check=True, + ) diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..64492f2 --- /dev/null +++ b/tox.ini @@ -0,0 +1,73 @@ +[tox] +envlist = pytest, sphinx +skipsdist = True +skip_missing_interpreters = True +whitelist_externals = python + +[testenv] +basepython = python + +[testenv:pytest] +conda_channels = + conda-forge + nodefaults +conda_deps = + # pytest + pytest + pytest-cookies + pytest-cov + pytest-xdist + + # Package dependencies + cookiecutter + +commands = + pytest {posargs} + +[testenv:sphinx] +changedir = docs/source +conda_env = docs/rtd_environment.yml +commands = + sphinx-build -T -b html -d {envtmpdir}/doctrees . {envtmpdir}/html + - sphinx-build -T -b linkcheck -d {envtmpdir}/doctrees . {envtmpdir}/linkcheck + + +[doc8] +ignore = D004 +ignore-path = + docs/build +ignore-path-errors = + {{cookiecutter.project_slug}}/README.rst;D000, + {{cookiecutter.project_slug}}/CHANGES.rst;D000 +max-line-length = 88 + +[flake8] +docstring-convention = numpy +ignore = + D ; ignore missing docstrings. + E203 ; ignore whitespace around : which is enforced by Black. + W503 ; ignore linebreak before binary operator which is enforced by Black. + PT006 ; ignore that parametrizing tests with tuple argument names is preferred. +max-line-length = 88 +per-file-ignores = + src/_pytask/hookspecs.py: U100 + src/_pytask/outcomes.py: N818 + tests/test_capture.py: T000, T001, N802, PT011 +pytest-mark-no-parentheses = true +warn-symbols = + pytest.mark.wip = Remove 'wip' mark for tests. + +[pytest] +addopts = --doctest-modules +filterwarnings = + ignore: the imp module is deprecated in favour of importlib + ignore: Using or importing the ABCs from 'collections' instead of from + ignore: The (parser|symbol) module is deprecated and will be removed in future +markers = + wip: Tests that are work-in-progress. + unit: Flag for unit tests which target mainly a single function. + integration: Flag for integration tests which may comprise of multiple unit tests. + end_to_end: Flag for tests that cover the whole program. +norecursedirs = + .idea + .tox diff --git a/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATE/bug_report.md b/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..e663479 --- /dev/null +++ b/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,35 @@ +--- + +name: Bug Report +about: Create a bug report to help us improve {{ cookiecutter.project_slug }} +title: "BUG:" +labels: "bug" + +--- + +- [ ] I have checked that this issue has not already been reported. + +- [ ] I have confirmed this bug exists on the latest version of {{ + cookiecutter.project_slug }}. + +- [ ] (optional) I have confirmed this bug exists on the `main` branch of {{ + cookiecutter.project_slug }}. + +--- + +**Note**: Please read [this +guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) detailing +how to provide the necessary information for us to reproduce your bug. + +#### Code Sample, a copy-pastable example + +```python +# Your code here +``` + +#### Problem description + +Explain **why** the current behaviour is a problem and why the expected output is a +better solution. + +#### Expected Output diff --git a/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATE/documentation.md b/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 0000000..9747ee7 --- /dev/null +++ b/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,23 @@ +--- + +name: Documentation Improvement +about: Report wrong or missing documentation +title: "DOC:" +labels: "documentation" + +--- + +#### Location of the documentation + +Provide the location of the documentation, e.g. an URL of the documentation. + +**Note**: You can check the latest versions of the docs on `main` +[here](https://{{ cookiecutter.project_slug }}.readthedocs.io/en/latest). + +#### Documentation problem + +Provide a description of what documentation you believe needs to be fixed/improved. + +#### Suggested fix for documentation + +Explain the suggested fix and **why** it's better than the existing documentation. diff --git a/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATE/enhancement.md b/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATE/enhancement.md new file mode 100644 index 0000000..980702f --- /dev/null +++ b/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATE/enhancement.md @@ -0,0 +1,34 @@ +--- + +name: Enhancement +about: Suggest an idea for {{ cookiecutter.project_slug }} +title: "ENH:" +labels: "enhancement" + +--- + +#### Is your feature request related to a problem? + +Provide a description of what the problem is, e.g. "I wish I could use +{{ cookiecutter.project_slug }} to do [...]". + +#### Describe the solution you'd like + +Provide a description of the feature request and how it might be implemented. + +#### API breaking implications + +Provide a description of how this feature will affect the API. + +#### Describe alternatives you've considered + +Provide a description of any alternative solutions or features you've considered. + +#### Additional context + +Add any other context, code examples, or references to existing implementations about +the feature request here. + +```python +# Your code here, if applicable +``` diff --git a/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATE/question.md b/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000..7049900 --- /dev/null +++ b/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,18 @@ +--- + +name: Submit Question +about: Ask a general question about {{ cookiecutter.project_slug }} +title: "QST:" +labels: "question" + +--- + +#### Question about pytask + +**Note**: If you'd still like to submit a question, please read [this guide]( +https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) detailing how to +provide the necessary information for us to reproduce your question. + +```python +# Your code here, if applicable +``` diff --git a/{{cookiecutter.project_slug}}/.github/pull_request_template.md b/{{cookiecutter.project_slug}}/.github/pull_request_template.md new file mode 100644 index 0000000..1414294 --- /dev/null +++ b/{{cookiecutter.project_slug}}/.github/pull_request_template.md @@ -0,0 +1,9 @@ +#### Changes + +Provide a description and/or bullet points to describe the changes in this PR. + +#### Todo + +- [ ] Reference issues which can be closed due to this PR with "Closes #x". +- [ ] Review whether the documentation needs to be updated. +- [ ] Document PR in CHANGES.rst. diff --git a/{{cookiecutter.project_slug}}/.github/workflows/main.yml b/{{cookiecutter.project_slug}}/.github/workflows/main.yml new file mode 100644 index 0000000..77f6ce1 --- /dev/null +++ b/{{cookiecutter.project_slug}}/.github/workflows/main.yml @@ -0,0 +1,82 @@ +name: Continuous Integration Workflow + +on: + push: + branches: + - main + pull_request: + branches: + - '*' + +jobs: + + run-tests: + + name: Run tests for ${{ matrix.os }} on ${{ matrix.python-version }} + runs-on: ${{ matrix.os }} + + strategy: + fail-fast: false + matrix: + os: ['ubuntu-latest', 'macos-latest', 'windows-latest'] + python-version: ['3.7', '3.8', '3.9'] + + steps: + - uses: actions/checkout@v2 + - uses: conda-incubator/setup-miniconda@v2 + with: + auto-update-conda: true + python-version: ${{ matrix.python-version }} + + - name: Install core dependencies. + shell: bash -l {0} + run: conda install -c conda-forge tox-conda coverage + + # Unit, integration, and end-to-end tests. + + - name: Run unit tests and doctests. + shell: bash -l {0} + run: tox -e pytest -- src tests -m "unit or (not integration and not end_to_end)" --cov=./ --cov-report=xml -n auto + + - name: Upload coverage report for unit tests and doctests. + if: runner.os == 'Linux' && matrix.python-version == '3.8' + shell: bash -l {0} + run: bash <(curl -s https://codecov.io/bash) -F unit -c + + - name: Run integration tests. + shell: bash -l {0} + run: tox -e pytest -- src tests -m integration --cov=./ --cov-report=xml -n auto + + - name: Upload coverage reports of integration tests. + if: runner.os == 'Linux' && matrix.python-version == '3.8' + shell: bash -l {0} + run: bash <(curl -s https://codecov.io/bash) -F integration -c + + - name: Run end-to-end tests. + shell: bash -l {0} + run: tox -e pytest -- src tests -m end_to_end --cov=./ --cov-report=xml -n auto + + - name: Upload coverage reports of end-to-end tests. + if: runner.os == 'Linux' && matrix.python-version == '3.8' + shell: bash -l {0} + run: bash <(curl -s https://codecov.io/bash) -F end_to_end -c + + + docs: + + name: Run documentation. + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + - uses: conda-incubator/setup-miniconda@v2 + with: + auto-update-conda: true + + - name: Install core dependencies. + shell: bash -l {0} + run: conda install -c conda-forge tox-conda + + - name: Build docs + shell: bash -l {0} + run: tox -e sphinx diff --git a/{{cookiecutter.project_slug}}/.pre-commit-config.yaml b/{{cookiecutter.project_slug}}/.pre-commit-config.yaml new file mode 100644 index 0000000..c49daac --- /dev/null +++ b/{{cookiecutter.project_slug}}/.pre-commit-config.yaml @@ -0,0 +1,105 @@ +repos: +- repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.0.1 + hooks: + - id: check-added-large-files + args: ['--maxkb=25'] + - id: check-case-conflict + - id: check-merge-conflict + - id: check-vcs-permalinks + - id: check-yaml + - id: debug-statements + - id: end-of-file-fixer + - id: fix-byte-order-marker + - id: forbid-new-submodules + - id: mixed-line-ending + - id: no-commit-to-branch + args: [--branch, main] + - id: trailing-whitespace +- repo: https://github.com/pre-commit/pygrep-hooks + rev: v1.9.0 + hooks: + - id: python-check-blanket-noqa + - id: python-check-mock-methods + - id: python-no-eval + - id: python-no-log-warn + - id: python-use-type-annotations + - id: rst-backticks + - id: rst-directive-colons + - id: rst-inline-touching-normal + - id: text-unicode-replacement-char +- repo: https://github.com/asottile/pyupgrade + rev: v2.29.1 + hooks: + - id: pyupgrade + args: [--py36-plus] +- repo: https://github.com/asottile/reorder_python_imports + rev: v2.6.0 + hooks: + - id: reorder-python-imports +- repo: https://github.com/asottile/setup-cfg-fmt + rev: v1.20.0 + hooks: + - id: setup-cfg-fmt +- repo: https://github.com/psf/black + rev: 21.12b0 + hooks: + - id: black +- repo: https://github.com/asottile/blacken-docs + rev: v1.12.0 + hooks: + - id: blacken-docs + additional_dependencies: [black] +- repo: https://github.com/PyCQA/flake8 + rev: 4.0.1 + hooks: + - id: flake8 + additional_dependencies: [ + flake8-alfred, + flake8-bugbear, + flake8-builtins, + flake8-comprehensions, + flake8-docstrings, + flake8-eradicate, + flake8-print, + flake8-pytest-style, + flake8-todo, + flake8-typing-imports, + flake8-unused-arguments, + pep8-naming, + pydocstyle, + Pygments, + ] +- repo: https://github.com/PyCQA/doc8 + rev: 0.10.1 + hooks: + - id: doc8 +- repo: https://github.com/econchick/interrogate + rev: 1.5.0 + hooks: + - id: interrogate + args: [-v, --fail-under=40, "{{cookiecutter.project_slug}}"] + pass_filenames: false +- repo: https://github.com/codespell-project/codespell + rev: v2.1.0 + hooks: + - id: codespell +- repo: https://github.com/guilatrova/tryceratops + rev: v1.0.0 + hooks: + - id: tryceratops +- repo: https://github.com/pre-commit/mirrors-mypy + rev: 'v0.910-1' + hooks: + - id: mypy + args: [ + --no-strict-optional, + --ignore-missing-imports, + ] + pass_filenames: false + language_version: "3.9" +- repo: meta + hooks: + - id: check-hooks-apply + - id: check-useless-excludes + # - id: identity # Prints all files passed to pre-commits. Debugging. diff --git a/{{cookiecutter.project_slug}}/.readthedocs.yaml b/{{cookiecutter.project_slug}}/.readthedocs.yaml new file mode 100644 index 0000000..5e35e9f --- /dev/null +++ b/{{cookiecutter.project_slug}}/.readthedocs.yaml @@ -0,0 +1,10 @@ +version: 2 + +build: + image: latest + +python: + version: 3.8 + +conda: + environment: docs/rtd_environment.yml diff --git a/{{cookiecutter.project_slug}}/CHANGES.rst b/{{cookiecutter.project_slug}}/CHANGES.rst new file mode 100644 index 0000000..9defdbd --- /dev/null +++ b/{{cookiecutter.project_slug}}/CHANGES.rst @@ -0,0 +1,9 @@ +Changes +======= + +This is a record of all past {{ cookiecutter.project_slug }} releases and what went into +them in reverse chronological order. + + +x.x.x - {% now 'local', '%Y' %}-xx-xx +------------------ diff --git a/{{cookiecutter.project_slug}}/LICENSE b/{{cookiecutter.project_slug}}/LICENSE new file mode 100644 index 0000000..cfcfbfb --- /dev/null +++ b/{{cookiecutter.project_slug}}/LICENSE @@ -0,0 +1,762 @@ +{% if 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 == 'BSD' %} +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 {{ cookiecutter.project_name }} 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 == 'ISCL' %} +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 == 'MIT' %} +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 == 'GNU General Public License v3' %} + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + 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 . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + 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 +. + + 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 +. +{% endif %} diff --git a/{{cookiecutter.project_slug}}/MANIFEST.in b/{{cookiecutter.project_slug}}/MANIFEST.in new file mode 100644 index 0000000..97dc9c8 --- /dev/null +++ b/{{cookiecutter.project_slug}}/MANIFEST.in @@ -0,0 +1,9 @@ +include CITATION +include LICENSE + +exclude *.yaml +exclude *.yml +exclude tox.ini + +prune docs +prune tests diff --git a/{{cookiecutter.project_slug}}/README.rst b/{{cookiecutter.project_slug}}/README.rst new file mode 100644 index 0000000..17b0da7 --- /dev/null +++ b/{{cookiecutter.project_slug}}/README.rst @@ -0,0 +1,43 @@ +{{ cookiecutter.project_name }} +{% for _ in cookiecutter.project_name %}={% endfor %} + +{% if cookiecutter.add_github_actions == "yes" %}.. image:: https://img.shields.io/github/workflow/status/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/main/main + :target: https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/actions?query=branch%3Amain +{% endif %} +{% if cookiecutter.add_readthedocs == "yes" %}.. image:: https://readthedocs.org/projects/{{ cookiecutter.project_slug | replace("_", "-") }}/badge/?version=latest + :target: https://{{ cookiecutter.project_slug | replace("_", "-") }}.readthedocs.io/en/latest/?badge=latest + :alt: Documentation Status +{% endif %} +{% if cookiecutter.add_codecov == "yes" %}.. image:: https://codecov.io/gh/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/branch/main/graph/badge.svg + :target: https://codecov.io/gh/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }} +{% endif %} +.. image:: https://results.pre-commit.ci/badge/github/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/main.svg + :target: https://results.pre-commit.ci/latest/github/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/main + :alt: pre-commit.ci status + +.. image:: https://img.shields.io/badge/code%20style-black-000000.svg + :target: https://github.com/ambv/black + + +Usage +----- + +To get started, create the environment with + +.. code-block:: console + + $ conda/mamba env create + +To build the project, type + +.. code-block:: console + + $ pytask + + +Credits +------- + +This project was created with `cookiecutter `_ +and the `cookiecutter-pytask `_ +template. diff --git a/{{cookiecutter.project_slug}}/environment.yml b/{{cookiecutter.project_slug}}/environment.yml new file mode 100644 index 0000000..6b837d6 --- /dev/null +++ b/{{cookiecutter.project_slug}}/environment.yml @@ -0,0 +1,34 @@ +name: {{ cookiecutter.conda_environment_name }} + +channels: + - conda-forge + - nodefaults + +dependencies: + - python >=3.7 + - pip + - setuptools_scm + - toml + + # Package dependencies + - pytask + + # Misc + - black + - pre-commit + - pytest + - pytest-cov + - pytest-xdist + - tox-conda + + # Documentation + - furo + - nbsphinx + - sphinx + - sphinx-autoapi + - sphinx-click + - sphinx-copybutton + - sphinx-panels + + - pip: + - -e . diff --git a/{{cookiecutter.project_slug}}/pyproject.toml b/{{cookiecutter.project_slug}}/pyproject.toml new file mode 100644 index 0000000..870324e --- /dev/null +++ b/{{cookiecutter.project_slug}}/pyproject.toml @@ -0,0 +1,23 @@ +[build-system] +requires = ["setuptools>=45", "wheel", "setuptools_scm[toml]>=6.0"] + + +[tool.setuptools_scm] +write_to = "src/{{ cookiecutter.project_slug }}/_version.py" + + +[tool.mypy] +files = ["src", "tests"] +check_untyped_defs = true +disallow_any_generics = true +disallow_incomplete_defs = true +disallow_untyped_defs = true +no_implicit_optional = true +warn_redundant_casts = true +warn_unused_ignores = true + + +[[tool.mypy.overrides]] +module = "tests.*" +disallow_untyped_defs = false +ignore_errors = true diff --git a/{{cookiecutter.project_slug}}/pytask.ini b/{{cookiecutter.project_slug}}/pytask.ini new file mode 100644 index 0000000..4a8e361 --- /dev/null +++ b/{{cookiecutter.project_slug}}/pytask.ini @@ -0,0 +1,2 @@ +[pytask] +paths = ./src/{{ cookiecutter.project_slug }} diff --git a/{{cookiecutter.project_slug}}/setup.cfg b/{{cookiecutter.project_slug}}/setup.cfg new file mode 100644 index 0000000..1eb243c --- /dev/null +++ b/{{cookiecutter.project_slug}}/setup.cfg @@ -0,0 +1,46 @@ +[metadata] +name = {{ cookiecutter.project_slug }} +description = A project with pytask. +long_description = file: README.rst +long_description_content_type = text/x-rst +url = hhttps://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }} +author = {{ cookiecutter.author }} +author_email = {{ cookiecutter.email }} +license = {{ cookiecutter.open_source_license }} +license_file = LICENSE +platforms = unix, linux, osx, cygwin, win32 +classifiers = + Intended Audience :: Science/Research + License :: OSI Approved :: {{ cookiecutter.open_source_license }} License + Operating System :: MacOS :: MacOS X + Operating System :: Microsoft :: Windows + Operating System :: POSIX + Programming Language :: Python :: 3 + Programming Language :: Python :: 3 :: Only + Programming Language :: Python :: 3.6 + Programming Language :: Python :: 3.7 + Programming Language :: Python :: 3.8 + Programming Language :: Python :: 3.9 + Programming Language :: Python :: 3.10 +project_urls = + Changelog = https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }} + Documentation = hhttps://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }} + Github = https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }} + Tracker = https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/issues + +[options] +packages = find: +install_requires = + pytask +python_requires = >=3.6.1 +include_package_data = True +package_dir = + =src +zip_safe = False + +[options.packages.find] +where = src + +[check-manifest] +ignore = + src/{{ cookiecutter.project_slug }}/_version.py diff --git a/{{cookiecutter.project_slug}}/src/{{cookiecutter.project_slug}}/config.py b/{{cookiecutter.project_slug}}/src/{{cookiecutter.project_slug}}/config.py new file mode 100644 index 0000000..4ae341a --- /dev/null +++ b/{{cookiecutter.project_slug}}/src/{{cookiecutter.project_slug}}/config.py @@ -0,0 +1,17 @@ +"""This module contains the general configuration of the project.""" +from pathlib import Path + + +try: + from ._version import version as __version__ +except ImportError: + # broken installation, we don't even try unknown only works because we do poor mans + # version compare + __version__ = "unknown" + + +SRC = Path(__file__).parent.resolve() +BLD = SRC.joinpath("..", "..", "bld") + + +__all__ = ["__version__", "BLD", "SRC"] diff --git a/{{cookiecutter.project_slug}}/tox.ini b/{{cookiecutter.project_slug}}/tox.ini new file mode 100644 index 0000000..b9b8519 --- /dev/null +++ b/{{cookiecutter.project_slug}}/tox.ini @@ -0,0 +1,60 @@ +[tox] +envlist = pytest, sphinx +skipsdist = True +skip_missing_interpreters = True +whitelist_externals = python + +[testenv] +basepython = python + +[testenv:pytest] +conda_channels = + conda-forge + nodefaults +conda_deps = + # pytest + pytest + pytest-cookies + pytest-cov + pytest-xdist + + # Package dependencies + pytask + +commands = + pytest {posargs} + +[doc8] +ignore = D004 +max-line-length = 88 + +[flake8] +docstring-convention = numpy +ignore = + D ; ignore missing docstrings. + E203 ; ignore whitespace around : which is enforced by Black. + W503 ; ignore linebreak before binary operator which is enforced by Black. + PT006 ; ignore that parametrizing tests with tuple argument names is preferred. +max-line-length = 88 +per-file-ignores = + src/_pytask/hookspecs.py: U100 + src/_pytask/outcomes.py: N818 + tests/test_capture.py: T000, T001, N802, PT011 +pytest-mark-no-parentheses = true +warn-symbols = + pytest.mark.wip = Remove 'wip' mark for tests. + +[pytest] +addopts = --doctest-modules +filterwarnings = + ignore: the imp module is deprecated in favour of importlib + ignore: Using or importing the ABCs from 'collections' instead of from + ignore: The (parser|symbol) module is deprecated and will be removed in future +markers = + wip: Tests that are work-in-progress. + unit: Flag for unit tests which target mainly a single function. + integration: Flag for integration tests which may comprise of multiple unit tests. + end_to_end: Flag for tests that cover the whole program. +norecursedirs = + .idea + .tox