├── .github └── workflows │ ├── ci.yml │ └── pre-commit-autoupdate.yml ├── .gitignore ├── README.md ├── copier.yml └── project_template ├── .github └── workflows │ ├── cd.yml │ └── ci.yml ├── .gitignore ├── .pre-commit-config.yaml ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── README.md ├── pyproject.toml ├── src └── {{python_name}} │ ├── __init__.py │ └── {% if typing != 'no_typing' %}py.typed{% endif %} ├── {% if license=='Apache' %}LICENSE{% endif %} ├── {% if license=='BSD' %}LICENSE{% endif %} ├── {% if license=='GPL' %}LICENSE{% endif %} ├── {% if license=='MIT' %}LICENSE{% endif %} └── {{_copier_conf.answers_file}} /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | on: 4 | workflow_dispatch: 5 | pull_request: 6 | push: 7 | branches: 8 | - main 9 | 10 | jobs: 11 | test-project-creation: 12 | name: Test project creation with ${{ matrix.typing }} typing 13 | runs-on: ubuntu-latest 14 | strategy: 15 | fail-fast: false 16 | matrix: 17 | typing: [no_typing, loose, strict] 18 | steps: 19 | - uses: actions/checkout@v4 20 | with: 21 | fetch-depth: 0 22 | - uses: actions/setup-python@v5 23 | with: 24 | python-version: "3.x" 25 | - name: Install Dependencies 26 | run: | 27 | pip install copier pre-commit 28 | - name: Create new project 29 | run: | 30 | mkdir my-project 31 | copier copy \ 32 | -d project_name=test \ 33 | -d project_short_description="A great package." \ 34 | -d python_name=test \ 35 | -d url=https://github.com/gh_actions/test \ 36 | -d min_python_version=3.10 \ 37 | -d org=gh_actions \ 38 | -d full_name=gh_actions \ 39 | -d email=foo@example.com \ 40 | -d license=BSD \ 41 | -d backend=setuptools \ 42 | -d typing=${{ matrix.typing }} \ 43 | -d coc=our_coc \ 44 | --vcs-ref HEAD \ 45 | . my-project 46 | - name: Check generated project installs with pip 47 | run: | 48 | cd my-project 49 | git config --global user.email "foo@example.com" 50 | git config --global user.name "gh_actions" 51 | git init 52 | git add . 53 | git commit -m "Initial commit" 54 | pip install -e . 55 | 56 | format-created-project: 57 | name: Try formatting the created project with ${{ matrix.typing }} typing 58 | runs-on: ubuntu-latest 59 | strategy: 60 | fail-fast: false 61 | matrix: 62 | typing: [no_typing, loose, strict] 63 | steps: 64 | - uses: actions/checkout@v4 65 | with: 66 | fetch-depth: 0 67 | - uses: actions/setup-python@v5 68 | with: 69 | python-version: "3.x" 70 | - name: Install Dependencies 71 | run: | 72 | pip install copier pre-commit 73 | - name: Create new project 74 | run: | 75 | mkdir my-project 76 | copier copy \ 77 | -d project_name=test \ 78 | -d project_short_description="A great package." \ 79 | -d python_name=test \ 80 | -d url=https://github.com/gh_actions/test \ 81 | -d min_python_version=3.10 \ 82 | -d org=gh_actions \ 83 | -d full_name=gh_actions \ 84 | -d email=foo@example.com \ 85 | -d license=BSD \ 86 | -d backend=setuptools \ 87 | -d typing=${{ matrix.typing }} \ 88 | -d coc=our_coc \ 89 | --vcs-ref HEAD \ 90 | . my-project 91 | - name: Run formatting checks 92 | run: | 93 | cd my-project 94 | git init 95 | git config --global user.email "foo@example.com" 96 | git config --global user.name "gh_actions" 97 | git add --all 98 | git commit -m "Initial commit" 99 | pre-commit run --all-files 100 | -------------------------------------------------------------------------------- /.github/workflows/pre-commit-autoupdate.yml: -------------------------------------------------------------------------------- 1 | name: update pre-commit hooks 2 | 3 | on: 4 | workflow_dispatch: 5 | schedule: 6 | - cron: "0 7 * * 1" 7 | 8 | jobs: 9 | update-template: 10 | if: github.repository == 'alan-turing-institute/python-project-template' 11 | runs-on: ubuntu-latest 12 | permissions: 13 | # Give the default GITHUB_TOKEN write permission to commit and push the 14 | # added or changed files to the repository. 15 | contents: write 16 | steps: 17 | - name: Checkout Code 18 | uses: actions/checkout@v4 19 | - name: Set up Python 20 | uses: actions/setup-python@v5 21 | with: 22 | python-version: "3.x" 23 | - name: Install pre-commit 24 | run: pip install pre-commit 25 | - name: Update pre-commit hooks 26 | run: | 27 | cd project_template 28 | pre-commit autoupdate 29 | 30 | - name: Push changes 31 | uses: stefanzweifel/git-auto-commit-action@v5 32 | with: 33 | add_options: "-u" 34 | commit_message: "chore: update pre-commit hooks" 35 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | share/python-wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | MANIFEST 28 | 29 | # PyInstaller 30 | # Usually these files are written by a python script from a template 31 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 32 | *.manifest 33 | *.spec 34 | 35 | # Installer logs 36 | pip-log.txt 37 | pip-delete-this-directory.txt 38 | 39 | # Unit test / coverage reports 40 | htmlcov/ 41 | .tox/ 42 | .nox/ 43 | .coverage 44 | .coverage.* 45 | .cache 46 | nosetests.xml 47 | coverage.xml 48 | *.cover 49 | *.py,cover 50 | .hypothesis/ 51 | .pytest_cache/ 52 | cover/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | .pybuilder/ 76 | target/ 77 | 78 | # Jupyter Notebook 79 | .ipynb_checkpoints 80 | 81 | # IPython 82 | profile_default/ 83 | ipython_config.py 84 | 85 | # pyenv 86 | # For a library or package, you might want to ignore these files since the code is 87 | # intended to run in multiple environments; otherwise, check them in: 88 | # .python-version 89 | 90 | # pipenv 91 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 92 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 93 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 94 | # install all needed dependencies. 95 | #Pipfile.lock 96 | 97 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 98 | __pypackages__/ 99 | 100 | # Celery stuff 101 | celerybeat-schedule 102 | celerybeat.pid 103 | 104 | # SageMath parsed files 105 | *.sage.py 106 | 107 | # Environments 108 | .env 109 | .venv 110 | env/ 111 | venv/ 112 | ENV/ 113 | env.bak/ 114 | venv.bak/ 115 | 116 | # Spyder project settings 117 | .spyderproject 118 | .spyproject 119 | 120 | # Rope project settings 121 | .ropeproject 122 | 123 | # mkdocs documentation 124 | /site 125 | 126 | # mypy 127 | .mypy_cache/ 128 | .dmypy.json 129 | dmypy.json 130 | 131 | # Pyre type checker 132 | .pyre/ 133 | 134 | # pytype static type analyzer 135 | .pytype/ 136 | 137 | # Cython debug symbols 138 | cython_debug/ 139 | 140 | # setuptools_scm 141 | src/*/_version.py 142 | 143 | 144 | # ruff 145 | .ruff_cache/ 146 | 147 | # OS specific stuff 148 | .DS_Store 149 | .DS_Store? 150 | ._* 151 | .Spotlight-V100 152 | .Trashes 153 | ehthumbs.db 154 | Thumbs.db 155 | 156 | # Common editor files 157 | *~ 158 | *.swp 159 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Template for Python projects 2 | 3 | This setuptools-based template is designed to help you get started with a new Python project, or migrate an existing codebase. It includes: 4 | 5 | - The recommended `src/` layout for a Python package 6 | - A pre-configured `pyproject.toml` that controls your project metadata 7 | - Linting + formatting via `ruff` and `pre-commit` 8 | - `pytest` set up to run automatically on your commits through GitHub Actions 9 | - Semi-automated releases to PyPI via GitHub tags + GitHub Actions 10 | - Opt-in typing support via `mypy` 11 | 12 | Based on the [Scientific Python project template](https://github.com/scientific-python/cookie). 13 | 14 | ## Sections in this README 15 | 16 | - [Setting up a new project](#setting-up-a-new-project) 17 | - [Using your new project](#using-your-new-project) 18 | - [Migrating an existing project](#migrating-an-existing-project) 19 | - [Python environment management](#python-environment-management) 20 | - [Installing your package in editable mode](#installing-your-package-in-editable-mode) 21 | - [Wrtiting code and running tests](#writing-code-and-running-tests) 22 | - [Formatting and checking your code](#formatting-and-checking-your-code) 23 | - [Publishing your package](#publishing-your-package) 24 | - [Updating your project when the template changes](#updating-your-project-when-the-template-changes) 25 | - [Inspiration](#inspiration) 26 | 27 | ## Setting up a new project 28 | 29 | To use, install `copier` in your Python environment: 30 | 31 | ``` 32 | python -m pip install copier 33 | ``` 34 | 35 | Then, run the following command to start the template configuration (but replace `my-package-name` with the name of your package): 36 | 37 | ``` 38 | copier copy gh:alan-turing-institute/python-project-template my-package-name 39 | ``` 40 | 41 | The output will be created in a folder called `my-package-name`, and will be created if it doesn't exist. 42 | 43 | You will be prompted for the following information: 44 | 45 | - `project_name`: The name of your project. This will be used to name the 46 | project directory, the Python package, and the GitHub repository. 47 | - `project_short_description`: A short description of your project. 48 | - `license`: The license to use for your project — PRs for other choices are welcome! The current supported options include: 49 | - `MIT` 50 | - `BSD-3-Clause` 51 | - `Apache-2.0` 52 | - `GPL-3.0` 53 | - `python_name`: The name of your project when you do `import name` (and potentially `pip install name`). This should be a valid Python package name (use underscores instead of hyphens, for example). 54 | - `typing`: Whether to use `mypy` for type checking. If you're not sure, I'd recommend basic checks (second option). 55 | - `python_version_range`: The range of Python versions to support. This will be used to set the `python_requires` field in `pyproject.toml`. Defaults to `>=3.10`. 56 | 57 | Great! Copier will have now created a new project in the directory you specified by replacing `my-package-name`, and customized it based on the information you provided. 58 | 59 | Your new project will have been set up with the following structure: 60 | 61 | ``` 62 | my-package-name/ 63 | ├── .github/ 64 | │ └── workflows/ 65 | │ └── ci.yml 66 | │ └── cd.yml 67 | ├── .gitignore 68 | ├── .pre-commit-config.yaml 69 | ├── CONTRIBUTING.md 70 | ├── CODE_OF_CONDUCT.md 71 | ├── LICENSE 72 | ├── README.md 73 | ├── pyproject.toml 74 | ├── src/ 75 | │ └── my_package_name/ 76 | │ └── __init__.py 77 | └── tests/ 78 | └── __init__.py 79 | ``` 80 | 81 | Here's a brief overview of the files and directories that have been created: 82 | 83 | - `.github/workflows/ci.yml`: A GitHub Actions workflow that runs your tests on every push to the repository. 84 | - `.github/workflows/cd.yml`: A GitHub Actions workflow that publishes your package to PyPI on every new version tag made through the GitHub interface. 85 | - `.gitignore`: A file that tells Git which files to ignore when committing changes. 86 | - `.pre-commit-config.yaml`: A configuration file for the `pre-commit` tool, which runs code checks and formatting on every commit. 87 | - `CONTRIBUTING.md`: A guide for people who want to contribute to your project, which has a lot of the same advice as this README. 88 | - `CODE_OF_CONDUCT.md`: A code of conduct for your project, which sets out the standards of behaviour you expect from contributors. You will likely need to edit or extend this to suit your project. 89 | - `LICENSE`: A copy of the license you chose for your project. 90 | - `README.md`: An overview of your project, which comes with some badges (example: ![Badge](https://img.shields.io/badge/this_is-a_badge-blue)) for things like CI status, code coverage, and PyPI version. 91 | - `pyproject.toml`: A TOML file that contains metadata about your project, including its name, version, description, and dependencies. 92 | - `src/`: A directory that contains your Python package code. 93 | - `tests/`: A directory that contains your tests. 94 | 95 | ### Migrating an existing project 96 | 97 | If you're taking code you've already written and want to use this template, you'll need to perform the following steps: 98 | 99 | - Start by moving your library code into the `src/{{ python_name }}` directory. 100 | - By library code, I mean the code that you want to be importable by other Python code. If you have things like experiments, scripts, or notebooks, you should keep them in the root directory under a different name (e.g. `examples`, `notebooks` etc.) 101 | - Copy over any tests you have into the `tests` directory. 102 | - Go through the `pyproject.toml` file and make sure that the metadata is correct. This includes the `name`, `description`, `version`, `authors`, `license`, and `classifiers` fields. 103 | - Add your dependencies to the relevant section of the `pyproject.toml` file under the `install_requires` field. Dependencies are formatted like this: 104 | ``` 105 | [project] 106 | install_requires = [ 107 | "numpy >= 1.20", 108 | "pandas == 1.2.3", 109 | "scipy", 110 | ] 111 | ``` 112 | where the first part is the package name, and the second part is the version specifier. You can find more information on version specifiers [here](https://www.python.org/dev/peps/pep-0440/#version-specifiers) to help you write these. 113 | 114 | Once you've set up your new project, you can start developing your package. There are some guidelines for development included in the [`CONTRIBUTING.md`](project_template/CONTRIBUTING.md) file generated in your project, but the main things are repeated below. 115 | 116 | 117 | ## Python environment management 118 | 119 | _Note: I will not be covering Conda environments in this section. Conda is great when your project has dependencies outside of Python packages that you want to manage! If you're using Conda, you can still use this template – these are just recommendations for managing Python environments that don't affect the package itself._ 120 | 121 | Every project should have a Python environment set up to manage dependencies. You can use the built-in Python tool `venv` to create a new environment in the root of your project. To create an environment called `.venv`, run the following command in your terminal: 122 | 123 | ``` 124 | python -m venv .venv 125 | ``` 126 | 127 | Then, activate the environment: 128 | 129 | - On Windows: 130 | 131 | ``` 132 | .venv\Scripts\activate 133 | ``` 134 | 135 | - On Unix or MacOS: 136 | ``` 137 | source .venv/bin/activate 138 | ``` 139 | 140 | Your version of python should now point to the one in the `.venv` directory. You can check this by running: `which python`, which should return a path to the python executable in the `.venv` directory (e.g. `my-package-name/.venv/bin/python`). 141 | 142 | Before installing your package to work on, I would also recommend upgrading `pip` and `setuptools` in your environment to the latest versions, which could potentially avoid issues with installing dependencies later on. You can do this by running the following command in your terminal while the environment is activated: 143 | 144 | ``` 145 | pip install --upgrade pip setuptools 146 | ``` 147 | 148 | 149 | ### Aside: Using `uv` for environment management 150 | 151 | There's also the environment manager [`uv`](https://astral.sh/uv), which has gained a lot of traction through being really fast, including some fun extras (e.g. [this one](https://twitter.com/HenrySchreiner3/status/1788801151686631584) that could save your old projects that no longer work with newer package versions). 152 | 153 | To install `uv`, [follow the install instructions on the GitHub page](https://github.com/astral-sh/uv?tab=readme-ov-file#getting-started), then run the following command in your terminal from the root of your project: 154 | 155 | ```bash 156 | uv venv --seed 157 | ``` 158 | 159 | This will create a new virtual environment in the `.venv` directory, with the `--seed` option upgrading `pip` and `setuptools` to the latest versions automatically. 160 | 161 | Activating the environment is the same as with `venv`: 162 | 163 | - On Windows: 164 | 165 | ```bash 166 | .venv\Scripts\activate 167 | ``` 168 | 169 | - On Unix or MacOS: 170 | ```bash 171 | source .venv/bin/activate 172 | ``` 173 | 174 | Then, to benefit from `uv`'s speed, you install your dependencies with: 175 | 176 | ```bash 177 | uv pip install ... # as you would with pip! 178 | ``` 179 | 180 | ## Installing your package in editable mode 181 | 182 | After your environment is set up, you can then install your project in editable mode (so that changes you make to the code are reflected in the installed package) by running: 183 | 184 | ```bash 185 | pip install -e . # or uv pip install -e . if you're using uv 186 | ``` 187 | 188 | This will install your package in editable mode, so you can import it in other Python code through `import my_package_name` and access methods as if it were any other package. The editable part means that if you make changes to the code in the `src` directory, they will be reflected in the installed package, so your changes will be immediately available to any code that uses your package that you're working on. 189 | 190 | ## Wrtiting code and running tests 191 | 192 | You're now ready to start developing your package! Add code to the `src` directory, tests to the `tests` directory, and run your tests with the `pytest` command to make sure everything is working as expected. Settings for `pytest` are included in the `pyproject.toml` file. 193 | 194 | Additionally, the automated CI pipeline will run the tests for you, but it's a good idea to run them locally as well to catch any issues before you push your code. 195 | 196 | ## Formatting and checking your code 197 | 198 | The tools for formatting and linting your code for errors are all bundled with [pre-commit](https://pre-commit.com/). Included are: 199 | - [ruff](https://astral.sh/ruff) (linting + formatting) 200 | - [mypy](https://mypy.readthedocs.io/en/stable/) (static type checking) 201 | - various other small fixes and checks (see the [`.pre-commit-config.yaml`](project_template/.pre-commit-config.yaml) file for more information) 202 | 203 | To have pre-commit check your files before you commit them, you can run the following command: 204 | 205 | ```bash 206 | pre-commit install 207 | ``` 208 | 209 | This will set up pre-commit to run the checks automatically on your files before you commit them. It's possible that pre-commit will make changes to your files when it runs the checks, so you should add those changes to your commit before you commit your code. A typical workflow would look like this: 210 | 211 | ```bash 212 | git add -u 213 | git commit -m "My commit message" 214 | # pre-commit will run the checks here; if it makes changes, you'll need to add them to your commit 215 | git add -u 216 | git commit -m "My commit message" 217 | # changes should have all been made by now and the commit should pass if there are no other issues 218 | # if your commit fails again here, you have to fix the issues manually (not everything can be fixed automatically). 219 | ``` 220 | 221 | One thing that is worth knowing is how to lint your files outside of the context of a commit. You can run the checks manually by running the following command: 222 | 223 | ```bash 224 | pre-commit run --all-files 225 | ``` 226 | 227 | This will run the checks on all files in your git project, regardless of whether they're staged for commit or not. 228 | 229 | ## Publishing your package 230 | 231 | If you're ready to publish your package to [PyPI](https://pypi.org/) (i.e. you want to be able to run `pip install my-package-name` from anywhere), the template includes a GitHub Actions workflow that will automatically publish your package to PyPI when you create a new release on GitHub. The workflow is defined in the [`.github/workflows/cd.yml`](project_template/.github/workflows/cd.yml) file within the `project_template` folder. 232 | 233 | First, if you don't already have a PyPI account, we'll follow these first steps from the [python packaging user guide](https://packaging.python.org/en/latest/tutorials/packaging-projects/#uploading-the-distribution-archives): 234 | 235 | >The first thing you’ll need to do is register an account on TestPyPI, which is a separate instance of the package index intended for testing and experimentation. It’s great for things like this tutorial where we don’t necessarily want to upload to the real index. To register an account, go to https://test.pypi.org/account/register/ and complete the steps on that page. You will also need to verify your email address before you’re able to upload any packages. For more details, see Using TestPyPI. 236 | 237 | Notice how the instructions mention TestPyPI, which is a testing environment for PyPI. This is a good place to start, since you can test publishing your package without affecting the real PyPI index. Once you're ready to publish to the real PyPI, you can follow the same steps again — just replace `https://test.pypi.org` with `https://pypi.org`. 238 | 239 | We'll then need to set up trusted publishing, which allows us to publish to PyPI without the need for a username/password or API token. This template uses the [PyPA GitHub action for publishing to PyPI](https://github.com/pypa/gh-action-pypi-publish/tree/release/v1.9?tab=readme-ov-file), which gives us the following instructions: 240 | 241 | > This action supports PyPI's [trusted publishing](https://docs.pypi.org/trusted-publishers/) implementation, which allows authentication to PyPI without a manually configured API token or username/password combination. To perform trusted publishing with this action, your project's publisher must already be [configured on PyPI](https://docs.pypi.org/trusted-publishers/adding-a-publisher/). 242 | 243 | After following these steps, we're basically there! You can now create a new release on GitHub using the "Releases" tab on the right-hand side, and the GitHub Actions workflow will automatically publish your package to PyPI using the commit associated with the release. **Note: you'll need to update the version number in the `pyproject.toml` file before creating a new release, since PyPI won't allow you to publish the same version twice!** 244 | 245 | Make sure to follow [semantic versioning](https://semver.org/) when updating the version number. If it's your first version of the package, I'd recommend starting at 0.1.0, with the major release 1.0.0 being the production-ready product. Use minor versions (0.X.0) for breaking changes, and patch versions (0.0.X) for backwards-compatible bug fixes. 246 | 247 | If this was your first time publishing, you will then be able to install your package from PyPI with `pip install my-package-name`. Yay! 248 | 249 | ## Updating your project when the template changes 250 | 251 | Copier has [instructions on how to update a template to the latest version](https://copier.readthedocs.io/en/stable/updating/), which I'll repeat here for completeness. 252 | 253 | If you want to update your project with the latest version of this template, you can run the following command (ensuring that your current project is committed and that you have no uncommitted changes, since the update will overwrite some files!): 254 | 255 | ```bash 256 | copier update 257 | ``` 258 | 259 | Note that this is the purpose of the `.copier-answers.yml` file in the root of your project. This file is used by Copier to keep track of the answers you gave when you first created the project, allowing it to update the project correctly when you run `copier update`. 260 | 261 | 262 | ## Inspiration 263 | 264 | This template heavily draws upon the [Scientific Python template](https://github.com/scientific-python/cookie) to motivate choices for default options for linters, backends etc. If you haven't worked with any of the tools in this repo (e.g. pre-commit, ruff, mypy, pytest) or want to know more about Python project setup in general, then you'll benefit from reading the fantastic [Scientific Python Development Guidelines](https://learn.scientific-python.org/development/). 265 | 266 | It's worth noting that the original template also has support for many more backends, including the use of compiled extensions (e.g. in Rust or C++). The only reason this is not a fork is that I wanted to both simplify the options available, and make the hard switch to [copier](https://copier.readthedocs.io/en/stable/) instead of [cookiecutter](https://cookiecutter.readthedocs.io/en/stable/) as a templating engine, since it lets you [natively update your project in-place to the latest template](https://copier.readthedocs.io/en/stable/updating/), even after you've worked on it for a while. 267 | -------------------------------------------------------------------------------- /copier.yml: -------------------------------------------------------------------------------- 1 | # CONFIGURATION ------------------------- 2 | _subdirectory: project_template 3 | _templates_suffix: "" 4 | _skip_if_exists: 5 | - CHANGELOG.md 6 | 7 | # PROMPT -------------------------------- 8 | project_name: 9 | type: str 10 | help: Please provide the name of your project. 11 | validator: >- 12 | {% if not project_name %} You must provide a name for the project. {% endif 13 | %} 14 | 15 | org: 16 | type: str 17 | help: What GitHub user is this project under? 18 | validator: >- 19 | {% if not org %} You must provide a org for the project. It might just be 20 | your user name on the site (like GitHub) you are targeting. {% endif %} 21 | 22 | url: 23 | type: str 24 | help: Provide/modify the url to your GitHub repository if needed. 25 | default: "https://github.com/{{org}}/{{project_name}}" 26 | 27 | python_name: 28 | type: str 29 | help: The Python package import name (for `import NAME` in Python code) 30 | default: "{{ project_name|lower|replace('-', '_')|replace(' ', '_') }}" 31 | 32 | full_name: 33 | type: str 34 | help: Who's the main responsible for this code? 35 | placeholder: My Name 36 | validator: >- 37 | {% if not full_name %} You must provide a name (possibly yours) to place in 38 | your config files. {% endif %} 39 | 40 | email: 41 | type: str 42 | help: What's their email? 43 | placeholder: me@email.com 44 | validator: >- 45 | {% if not (email | regex_search('^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*$')) %} 46 | You must provide a valid email to place in 47 | your config files. 48 | {% endif %} 49 | 50 | project_short_description: 51 | type: str 52 | help: Write a short description of your project. 53 | default: A great package. 54 | 55 | license: 56 | type: str 57 | help: Select a license 58 | choices: 59 | - BSD 60 | - Apache 61 | - MIT 62 | - GPL 63 | 64 | min_python_version: 65 | type: str 66 | help: What is the minimum version of Python your project will support? (Defaults to minimum supported by NumPy) 67 | default: "3.10" 68 | validator: >- 69 | {% if not (min_python_version | regex_search('[3][.][0-9]+')) %} 70 | Please supply a valid Python 3 version (e.g. 3.11). 71 | {% endif %} 72 | 73 | typing: 74 | type: str 75 | help: Would you like to use static type checking? (This configures mypy.) 76 | choices: 77 | "No/I'll configure it myself.": no_typing 78 | "Basic type checking (type annotations not required).": loose 79 | "Full type checking (type annotations required).": strict 80 | 81 | coc: 82 | type: str 83 | help: We provide a basic Code of Conduct that can be modified to suit the needs of your project. Would you like to use this, or write your own? 84 | choices: 85 | "I'll use/modify the basic Code of Conduct.": our_coc 86 | "I'll write my own Code of Conduct.": their_coc 87 | -------------------------------------------------------------------------------- /project_template/.github/workflows/cd.yml: -------------------------------------------------------------------------------- 1 | name: CD 2 | 3 | on: 4 | workflow_dispatch: 5 | pull_request: 6 | push: 7 | branches: 8 | - main 9 | release: 10 | types: 11 | - published 12 | 13 | jobs: 14 | dist: 15 | needs: [pre-commit] 16 | name: Distribution build 17 | runs-on: ubuntu-latest 18 | 19 | steps: 20 | - uses: actions/checkout@v4 21 | with: 22 | fetch-depth: 0 23 | 24 | - name: Build sdist and wheel 25 | run: pipx run build 26 | 27 | - uses: actions/upload-artifact@v3 28 | with: 29 | path: dist 30 | 31 | - name: Check products 32 | run: pipx run twine check dist/* 33 | 34 | publish: 35 | needs: [dist] 36 | name: Publish to PyPI 37 | environment: pypi 38 | permissions: 39 | id-token: write 40 | runs-on: ubuntu-latest 41 | if: github.event_name == 'release' && github.event.action == 'published' 42 | 43 | steps: 44 | - uses: actions/download-artifact@v3 45 | with: 46 | name: artifact 47 | path: dist 48 | 49 | - uses: pypa/gh-action-pypi-publish@release/v1 50 | if: github.event_name == 'release' && github.event.action == 'published' 51 | with: 52 | # Remove this line to publish to PyPI 53 | repository-url: https://test.pypi.org/legacy/ 54 | -------------------------------------------------------------------------------- /project_template/.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | on: 4 | workflow_dispatch: 5 | pull_request: 6 | push: 7 | branches: 8 | - main 9 | 10 | jobs: 11 | pre-commit: 12 | name: Format + lint code 13 | runs-on: ubuntu-latest 14 | steps: 15 | - uses: actions/checkout@v4 16 | with: 17 | fetch-depth: 0 18 | - uses: actions/setup-python@v4 19 | with: 20 | python-version: "3.x" 21 | - uses: pre-commit/action@v3.0.0 22 | with: 23 | extra_args: --hook-stage manual --all-files 24 | 25 | checks: 26 | name: {% raw %}Run tests for Python ${{ matrix.python-version }} on ${{ matrix.runs-on }}{% endraw %} 27 | runs-on: {% raw %}${{ matrix.runs-on }}{% endraw %} 28 | needs: [pre-commit] 29 | strategy: 30 | fail-fast: false 31 | matrix: 32 | python-version: ["{{ min_python_version }}", "3.12"] # test oldest and latest supported versions 33 | runs-on: [ubuntu-latest, macos-latest] # can be extended to other OSes, e.g. [ubuntu-latest, macos-latest, windows-latest] 34 | 35 | steps: 36 | - uses: actions/checkout@v4 37 | with: 38 | fetch-depth: 0 39 | 40 | - uses: actions/setup-python@v4 41 | with: 42 | python-version: {% raw %}${{ matrix.python-version }}{% endraw %} 43 | allow-prereleases: true 44 | 45 | - name: Install package 46 | run: python -m pip install .[dev] 47 | 48 | - name: Test package 49 | run: >- 50 | python -m pytest -ra --cov --cov-report=xml --cov-report=term 51 | --durations=20 52 | 53 | - name: Upload coverage report 54 | uses: codecov/codecov-action@v3.1.4 55 | -------------------------------------------------------------------------------- /project_template/.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | share/python-wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | MANIFEST 28 | 29 | # PyInstaller 30 | # Usually these files are written by a python script from a template 31 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 32 | *.manifest 33 | *.spec 34 | 35 | # Installer logs 36 | pip-log.txt 37 | pip-delete-this-directory.txt 38 | 39 | # Unit test / coverage reports 40 | htmlcov/ 41 | .tox/ 42 | .nox/ 43 | .coverage 44 | .coverage.* 45 | .cache 46 | nosetests.xml 47 | coverage.xml 48 | *.cover 49 | *.py,cover 50 | .hypothesis/ 51 | .pytest_cache/ 52 | cover/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | .pybuilder/ 76 | target/ 77 | 78 | # Jupyter Notebook 79 | .ipynb_checkpoints 80 | 81 | # IPython 82 | profile_default/ 83 | ipython_config.py 84 | 85 | # pyenv 86 | # For a library or package, you might want to ignore these files since the code is 87 | # intended to run in multiple environments; otherwise, check them in: 88 | # .python-version 89 | 90 | # pipenv 91 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 92 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 93 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 94 | # install all needed dependencies. 95 | #Pipfile.lock 96 | 97 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 98 | __pypackages__/ 99 | 100 | # Celery stuff 101 | celerybeat-schedule 102 | celerybeat.pid 103 | 104 | # SageMath parsed files 105 | *.sage.py 106 | 107 | # Environments 108 | .env 109 | .venv 110 | env/ 111 | venv/ 112 | ENV/ 113 | env.bak/ 114 | venv.bak/ 115 | 116 | # Spyder project settings 117 | .spyderproject 118 | .spyproject 119 | 120 | # Rope project settings 121 | .ropeproject 122 | 123 | # mkdocs documentation 124 | /site 125 | 126 | # mypy 127 | .mypy_cache/ 128 | .dmypy.json 129 | dmypy.json 130 | 131 | # Pyre type checker 132 | .pyre/ 133 | 134 | # pytype static type analyzer 135 | .pytype/ 136 | 137 | # Cython debug symbols 138 | cython_debug/ 139 | 140 | # setuptools_scm 141 | src/*/_version.py 142 | 143 | 144 | # ruff 145 | .ruff_cache/ 146 | 147 | # OS specific stuff 148 | .DS_Store 149 | .DS_Store? 150 | ._* 151 | .Spotlight-V100 152 | .Trashes 153 | ehthumbs.db 154 | Thumbs.db 155 | 156 | # Common editor files 157 | *~ 158 | *.swp 159 | -------------------------------------------------------------------------------- /project_template/.pre-commit-config.yaml: -------------------------------------------------------------------------------- 1 | ci: 2 | autoupdate_commit_msg: "chore: update pre-commit hooks" 3 | autofix_commit_msg: "style: pre-commit fixes" 4 | 5 | repos: 6 | - repo: https://github.com/pre-commit/pre-commit-hooks 7 | rev: "v5.0.0" 8 | hooks: 9 | - id: check-added-large-files 10 | - id: check-case-conflict 11 | - id: check-merge-conflict 12 | - id: check-symlinks 13 | - id: check-yaml 14 | - id: debug-statements 15 | - id: end-of-file-fixer 16 | - id: mixed-line-ending 17 | - id: name-tests-test 18 | args: ["--pytest-test-first"] 19 | - id: requirements-txt-fixer 20 | - id: trailing-whitespace 21 | 22 | - repo: https://github.com/astral-sh/ruff-pre-commit 23 | rev: "v0.11.12" 24 | hooks: 25 | # first, lint + autofix 26 | - id: ruff 27 | types_or: [python, pyi, jupyter] 28 | args: ["--fix", "--show-fixes"] 29 | # then, format 30 | - id: ruff-format 31 | 32 | - repo: https://github.com/pre-commit/mirrors-mypy 33 | rev: "v1.16.0" 34 | hooks: 35 | - id: mypy 36 | files: src 37 | args: [] 38 | additional_dependencies: 39 | - pytest 40 | -------------------------------------------------------------------------------- /project_template/CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | {%- if coc == "their_coc" -%} 2 | File was automatically generated, please fill me in (or raise an issue on this repo if you see me blank!) 3 | {%- elif coc == "our_coc" -%} 4 | # Code of Conduct 5 | 6 | We value the participation of every member of our community and want to ensure 7 | that every contributor has an enjoyable and fulfilling experience. Accordingly, 8 | everyone who participates in the {{ project_name }} project is expected to show respect and courtesy to other community members at all time. 9 | 10 | In the interest of fostering an open and welcoming environment, we as 11 | contributors and maintainers are dedicated to making participation in our project 12 | a harassment-free experience for everyone, regardless of age, body 13 | size, disability, ethnicity, sex characteristics, gender identity and expression, 14 | level of experience, education, socio-economic status, nationality, personal 15 | appearance, race, religion, or sexual identity and orientation. 16 | 17 | ## Our Standards 18 | 19 | Examples of behaviour that contributes to creating a positive environment 20 | include: 21 | 22 | - Using welcoming and inclusive language 23 | - Being respectful of differing viewpoints and experiences 24 | - Gracefully accepting constructive criticism 25 | - Focusing on what is best for the community 26 | - Showing empathy towards other community members 27 | 28 | Examples of unacceptable behaviour by participants include: 29 | 30 | - The use of sexualized language or imagery and unwelcome sexual attention or 31 | advances 32 | - Trolling, insulting/derogatory comments, and personal or political attacks 33 | - Public or private harassment 34 | - Publishing others' private information, such as a physical or electronic 35 | address, without explicit permission 36 | - Other conduct which could reasonably be considered inappropriate in a 37 | professional setting 38 | 39 | 46 | 47 | ## Attribution 48 | 49 | This Code of Conduct is adapted from the [Turing Data Stories Code of Conduct](https://github.com/alan-turing-institute/TuringDataStories/blob/main/CODE_OF_CONDUCT.md) which is based on the [scona project Code of Conduct](https://github.com/WhitakerLab/scona/blob/master/CODE_OF_CONDUCT.md) 50 | and the [Contributor Covenant](https://www.contributor-covenant.org), version [1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html) 51 | {%- endif %} 52 | -------------------------------------------------------------------------------- /project_template/CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | See the [Scientific Python Developer Guide][spc-dev-intro] for a detailed 2 | description of best practices for developing scientific packages. 3 | 4 | [spc-dev-intro]: https://learn.scientific-python.org/development/ 5 | 6 | # Setting up a development environment manually 7 | 8 | You can set up a development environment by running: 9 | 10 | ```zsh 11 | python3 -m venv venv # create a virtualenv called venv 12 | source ./venv/bin/activate # now `python` points to the virtualenv python 13 | pip install -v -e ".[dev]" # -v for verbose, -e for editable, [dev] for dev dependencies 14 | ``` 15 | 16 | # Post setup 17 | 18 | You should prepare pre-commit, which will help you by checking that commits pass 19 | required checks: 20 | 21 | ```bash 22 | pip install pre-commit # or brew install pre-commit on macOS 23 | pre-commit install # this will install a pre-commit hook into the git repo 24 | ``` 25 | 26 | You can also/alternatively run `pre-commit run` (changes only) or 27 | `pre-commit run --all-files` to check even without installing the hook. 28 | 29 | # Testing 30 | 31 | Use pytest to run the unit checks: 32 | 33 | ```bash 34 | pytest 35 | ``` 36 | 37 | # Coverage 38 | 39 | Use pytest-cov to generate coverage reports: 40 | 41 | ```bash 42 | pytest --cov={{ python_name }} 43 | ``` 44 | 45 | # Pre-commit 46 | 47 | This project uses pre-commit for all style checking. Install pre-commit and run: 48 | 49 | ```bash 50 | pre-commit run -a 51 | ``` 52 | 53 | to check all files. 54 | -------------------------------------------------------------------------------- /project_template/README.md: -------------------------------------------------------------------------------- 1 | # {{ project_name }} 2 | 3 | [![Actions Status][actions-badge]][actions-link] 4 | [![PyPI version][pypi-version]][pypi-link] 5 | [![PyPI platforms][pypi-platforms]][pypi-link] 6 | 7 | {{ project_short_description }} 8 | 9 | ## Installation 10 | 11 | ```bash 12 | python -m pip install {{ python_name }} 13 | ``` 14 | 15 | From source: 16 | {% if backend == "poetry" -%} 17 | ```bash 18 | git clone {{ url }} 19 | cd {{ project_name }} 20 | poetry install 21 | ``` 22 | {% else -%} 23 | ```bash 24 | git clone {{ url }} 25 | cd {{ project_name }} 26 | python -m pip install . 27 | ``` 28 | {%- endif %} 29 | 30 | ## Usage 31 | 32 | 33 | ## Contributing 34 | 35 | See [CONTRIBUTING.md](CONTRIBUTING.md) for instructions on how to contribute. 36 | 37 | ## License 38 | 39 | Distributed under the terms of the [{{ license }} license](LICENSE). 40 | 41 | 42 | 43 | [actions-badge]: {{url}}/workflows/CI/badge.svg 44 | [actions-link]: {{url}}/actions 45 | [pypi-link]: https://pypi.org/project/{{project_name}}/ 46 | [pypi-platforms]: https://img.shields.io/pypi/pyversions/{{project_name}} 47 | [pypi-version]: https://img.shields.io/pypi/v/{{project_name}} 48 | 49 | -------------------------------------------------------------------------------- /project_template/pyproject.toml: -------------------------------------------------------------------------------- 1 | [build-system] 2 | requires = ["setuptools>=61"] 3 | build-backend = "setuptools.build_meta" 4 | 5 | [project] 6 | name = "{{ project_name }}" 7 | version = "0.1.0" 8 | authors = [ 9 | { name = "{{ full_name }}", email = "{{ email }}" }, 10 | ] 11 | description = "{{ project_short_description }}" 12 | readme = "README.md" 13 | requires-python = ">={{ min_python_version }}" 14 | classifiers = [ 15 | "Development Status :: 1 - Planning", 16 | "Intended Audience :: Science/Research", 17 | "Intended Audience :: Developers", 18 | {%- if license == "BSD" %} 19 | "License :: OSI Approved :: BSD License", 20 | {%- elif license == "Apache" %} 21 | "License :: OSI Approved :: Apache Software License", 22 | {%- elif license == "MIT" %} 23 | "License :: OSI Approved :: MIT License", 24 | {%- elif license == "GPL" %} 25 | "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", 26 | {%- endif %} 27 | "Operating System :: OS Independent", 28 | "Programming Language :: Python", 29 | "Programming Language :: Python :: 3", 30 | "Programming Language :: Python :: 3 :: Only", 31 | "Programming Language :: Python :: 3.9", 32 | "Programming Language :: Python :: 3.10", 33 | "Programming Language :: Python :: 3.11", 34 | "Programming Language :: Python :: 3.12", 35 | "Topic :: Scientific/Engineering", 36 | {%- if typing != "no_typing" %} 37 | "Typing :: Typed", 38 | {%- endif %} 39 | ] 40 | dependencies = [] 41 | 42 | [project.optional-dependencies] 43 | dev = [ 44 | "pytest >=6", 45 | "pytest-cov >=3", 46 | "pre-commit", 47 | ] 48 | 49 | [project.urls] 50 | Homepage = "{{ url }}" 51 | "Bug Tracker" = "{{ url }}/issues" 52 | Discussions = "{{ url }}/discussions" 53 | Changelog = "{{ url }}/releases" 54 | 55 | [tool.pytest.ini_options] 56 | minversion = "6.0" 57 | addopts = ["-ra", "--showlocals", "--strict-markers", "--strict-config"] 58 | xfail_strict = true 59 | filterwarnings = [ 60 | "error", 61 | ] 62 | log_cli_level = "INFO" 63 | testpaths = [ 64 | "tests", 65 | ] 66 | 67 | [tool.coverage] 68 | run.source = ["{{ python_name }}"] 69 | port.exclude_lines = [ 70 | 'pragma: no cover', 71 | '\.\.\.', 72 | 'if typing.TYPE_CHECKING:', 73 | ] 74 | 75 | {% if typing != "no_typing" -%} 76 | [tool.mypy] 77 | files = ["src", "tests"] 78 | python_version = "{{ min_python_version }}" 79 | show_error_codes = true 80 | warn_unreachable = true 81 | disallow_untyped_defs = false 82 | disallow_incomplete_defs = false 83 | check_untyped_defs = true 84 | {% if typing == "loose" -%} 85 | strict = false 86 | {% elif typing == "strict" -%} 87 | strict = true 88 | enable_error_code = ["ignore-without-code", "redundant-expr", "truthy-bool"] 89 | 90 | [[tool.mypy.overrides]] 91 | module = "{{ python_name }}.*" 92 | disallow_untyped_defs = true 93 | disallow_incomplete_defs = true 94 | {%- endif %} 95 | {%- endif %} 96 | 97 | [tool.ruff] 98 | src = ["src"] 99 | exclude = [] 100 | line-length = 88 # how long you want lines to be 101 | 102 | [tool.ruff.format] 103 | docstring-code-format = true # code snippets in docstrings will be formatted 104 | 105 | [tool.ruff.lint] 106 | select = [ 107 | "E", "F", "W", # flake8 108 | "B", # flake8-bugbear 109 | "I", # isort 110 | "ARG", # flake8-unused-arguments 111 | "C4", # flake8-comprehensions 112 | "EM", # flake8-errmsg 113 | "ICN", # flake8-import-conventions 114 | "ISC", # flake8-implicit-str-concat 115 | "G", # flake8-logging-format 116 | "PGH", # pygrep-hooks 117 | "PIE", # flake8-pie 118 | "PL", # pylint 119 | "PT", # flake8-pytest-style 120 | "RET", # flake8-return 121 | "RUF", # Ruff-specific 122 | "SIM", # flake8-simplify 123 | "UP", # pyupgrade 124 | "YTT", # flake8-2020 125 | "EXE", # flake8-executable 126 | ] 127 | ignore = [ 128 | "PLR", # Design related pylint codes 129 | "ISC001", # Conflicts with formatter 130 | ] 131 | unfixable = [ 132 | "F401", # Would remove unused imports 133 | "F841", # Would remove unused variables 134 | ] 135 | flake8-unused-arguments.ignore-variadic-names = true # allow unused *args/**kwargs 136 | {%- if typing != "no_typing" -%} 137 | isort.required-imports = ["from __future__ import annotations"] 138 | {%- endif %} 139 | -------------------------------------------------------------------------------- /project_template/src/{{python_name}}/__init__.py: -------------------------------------------------------------------------------- 1 | """ 2 | {{ project_name }}: {{ project_short_description }} 3 | """ 4 | 5 | from __future__ import annotations 6 | 7 | from importlib.metadata import version 8 | 9 | __all__ = ("__version__",) 10 | __version__ = version(__name__) 11 | -------------------------------------------------------------------------------- /project_template/src/{{python_name}}/{% if typing != 'no_typing' %}py.typed{% endif %}: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/alan-turing-institute/python-project-template/203d1cda277f64b5a4c8b6fc23929b04cf2bff21/project_template/src/{{python_name}}/{% if typing != 'no_typing' %}py.typed{% endif %} -------------------------------------------------------------------------------- /project_template/{% if license=='Apache' %}LICENSE{% endif %}: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright 2024 {{ full_name }} 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /project_template/{% if license=='BSD' %}LICENSE{% endif %}: -------------------------------------------------------------------------------- 1 | BSD 3-Clause License 2 | 3 | Copyright (c) 2024, {{ full_name }}. 4 | All rights reserved. 5 | 6 | Redistribution and use in source and binary forms, with or without 7 | modification, are permitted provided that the following conditions are met: 8 | 9 | * Redistributions of source code must retain the above copyright notice, this 10 | list of conditions and the following disclaimer. 11 | 12 | * Redistributions in binary form must reproduce the above copyright notice, 13 | this list of conditions and the following disclaimer in the documentation 14 | and/or other materials provided with the distribution. 15 | 16 | * Neither the name of the vector package developers nor the names of its 17 | contributors may be used to endorse or promote products derived from 18 | this software without specific prior written permission. 19 | 20 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 21 | AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 23 | DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 24 | FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25 | DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 26 | SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 27 | CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 28 | OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 29 | OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30 | -------------------------------------------------------------------------------- /project_template/{% if license=='GPL' %}LICENSE{% endif %}: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /project_template/{% if license=='MIT' %}LICENSE{% endif %}: -------------------------------------------------------------------------------- 1 | Copyright 2024 {{ full_name }} 2 | 3 | Permission is hereby granted, free of charge, to any person obtaining a copy of 4 | this software and associated documentation files (the "Software"), to deal in 5 | the Software without restriction, including without limitation the rights to 6 | use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies 7 | of the Software, and to permit persons to whom the Software is furnished to do 8 | so, subject to the following conditions: 9 | 10 | The above copyright notice and this permission notice shall be included in all 11 | copies or substantial portions of the Software. 12 | 13 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 18 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 19 | SOFTWARE. 20 | -------------------------------------------------------------------------------- /project_template/{{_copier_conf.answers_file}}: -------------------------------------------------------------------------------- 1 | # Changes here will be overwritten by Copier 2 | {{ _copier_answers|to_nice_yaml -}} 3 | --------------------------------------------------------------------------------