├── .github └── workflows │ ├── autoupdate.yml │ └── ci.yml ├── .gitignore ├── LICENSE.txt ├── Makefile ├── README.md ├── copier.yml └── template └── {{ pypi_name }} ├── .editorconfig ├── .github ├── ISSUE_TEMPLATE │ ├── BUG_REPORT.yml │ └── FEATURE_REQUEST.yml └── workflows │ ├── ci.yml.jinja │ └── release.yml.jinja ├── .gitignore ├── .pre-commit-config.yaml ├── CODE_OF_CONDUCT.md.jinja ├── CONTRIBUTING.md ├── LICENSE.txt ├── PULL_REQUEST_TEMPLATE.md ├── README.md.jinja ├── pyproject.toml.jinja ├── tests ├── __init__.py └── test_version.py.jinja ├── {% if add_docs %}.readthedocs.yaml{% endif %} ├── {% if add_docs %}docs{% endif %} ├── conf.py.jinja ├── index.rst.jinja └── requirements.txt.jinja ├── {{ _copier_conf.answers_file }}.jinja └── {{ module_name }} ├── __init__.py.jinja ├── py.typed └── {% if is_app %}__main__.py{% endif %}.jinja /.github/workflows/autoupdate.yml: -------------------------------------------------------------------------------- 1 | name: Autoupdate 2 | on: 3 | push: 4 | workflow_dispatch: 5 | schedule: 6 | - cron: "0 0 1 * *" # Run every month 7 | jobs: 8 | main: 9 | runs-on: ubuntu-latest 10 | steps: 11 | - name: Check out repository code 12 | uses: actions/checkout@v3 13 | - name: Set up Python 3.12 14 | uses: actions/setup-python@v4 15 | with: 16 | python-version: 3.12 17 | - name: Install dependencies 18 | run: python3 -m pip install --upgrade pip copier poetry 19 | - name: Update template 20 | run: make all 21 | - name: Check if we should commit 22 | id: commit_check 23 | run: | 24 | if git diff --quiet 25 | then 26 | echo "should_commit==false" >> $GITHUB_OUTPUT 27 | else 28 | echo "should_commit==true" >> $GITHUB_OUTPUT 29 | fi 30 | - name: Commit updated lockfiles 31 | uses: EndBug/add-and-commit@v9 32 | id: make_commit 33 | if: ${{ contains(steps.commit_check.outputs.should_commit, 'true') }} 34 | with: 35 | default_author: github_actions 36 | message: ":robot: :arrow_up: Updated deps and lockfile\n\nThis is an automated action" 37 | - name: Generate tag 38 | id: gen_tag_name 39 | if: ${{ contains(steps.commit_check.outputs.should_commit, 'true') }} 40 | run: | 41 | git fetch --tags 42 | NEW_TAG=$(git tag -l | sort -V | tail -n 1 | awk -F. -v OFS=. 'NF==1{print ++$NF}; NF>1{$NF=sprintf("%0*d", length($NF), ($NF+1)); print}') 43 | echo "NEW_TAG=$NEW_TAG" >> "$GITHUB_OUTPUT" 44 | - uses: rickstaa/action-create-tag@v1 45 | if: ${{ contains(steps.commit_check.outputs.should_commit, 'true') }} 46 | with: 47 | tag: "${{ steps.gen_tag_name.outputs.NEW_TAG }}" 48 | commit_sha: "${{ steps.make_commit.outputs.commit_long_sha }}" 49 | -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: 3 | - push 4 | - pull_request 5 | jobs: 6 | build: 7 | runs-on: ubuntu-latest 8 | steps: 9 | - name: Check out repository code 10 | uses: actions/checkout@v3 11 | - name: Set up Python 3.12 12 | uses: actions/setup-python@v4 13 | with: 14 | python-version: 3.12 15 | - name: Install dependencies 16 | run: python3 -m pip install --upgrade pip copier poetry poethepoet 17 | - name: Create default options 18 | run: make setup-env 19 | 20 | - name: Build example template 21 | run: copier copy gh:ThatXliner/pyt2 . -a .copier-answers.yml --defaults --vcs-ref HEAD 22 | - name: Build example 23 | working-directory: cool-example 24 | run: | 25 | poetry install 26 | poetry build 27 | - name: Run example tasks 28 | working-directory: cool-example 29 | run: | 30 | poe docs 31 | poe style 32 | poe codebase 33 | poe test 34 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .copier-answers.yml 2 | .DS_Store 3 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | This is free and unencumbered software released into the public domain. 2 | 3 | Anyone is free to copy, modify, publish, use, compile, sell, or 4 | distribute this software, either in source code form or as a compiled 5 | binary, for any purpose, commercial or non-commercial, and by any 6 | means. 7 | 8 | In jurisdictions that recognize copyright laws, the author or authors 9 | of this software dedicate any and all copyright interest in the 10 | software to the public domain. We make this dedication for the benefit 11 | of the public at large and to the detriment of our heirs and 12 | successors. We intend this dedication to be an overt act of 13 | relinquishment in perpetuity of all present and future rights to this 14 | software under copyright law. 15 | 16 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 17 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 18 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 19 | IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR 20 | OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 21 | ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 22 | OTHER DEALINGS IN THE SOFTWARE. 23 | 24 | For more information, please refer to 25 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | all: 2 | $(MAKE) docs 3 | $(MAKE) nodocs 4 | pre-clean: 5 | rm -rf 'template/{{ pypi_name }}/{% if add_docs %}poetry.lock{% endif %}' 'template/{{ pypi_name }}/{% if not add_docs %}poetry.lock{% endif %}' 6 | clean: 7 | rm -rf cool-example .copier-answers.yml 8 | setup-env: 9 | echo '{"add_docs":true,"author":"Bryan Hu","email":"bryan.hu.2020@gmail.com","is_app":true,"module_name":"cool_example","project_description":"Example description.","project_name":"Cool Example","pypi_name":"cool-example","username":"ThatXliner"}' > .copier-answers.yml 10 | run: 11 | cd cool-example && poetry install && poetry update --lock 12 | docs: pre-clean 13 | $(MAKE) setup-env 14 | copier copy gh:ThatXliner/pyt2 . -a .copier-answers.yml --defaults -d add_docs=true --vcs-ref HEAD 15 | $(MAKE) run 16 | cp cool-example/poetry.lock 'template/{{ pypi_name }}/{% if add_docs %}poetry.lock{% endif %}' 17 | $(MAKE) clean 18 | nodocs: pre-clean 19 | $(MAKE) setup-env 20 | copier copy gh:ThatXliner/pyt2 . -a .copier-answers.yml --defaults -d add_docs=false --vcs-ref HEAD 21 | $(MAKE) run 22 | cp cool-example/poetry.lock 'template/{{ pypi_name }}/{% if not add_docs %}poetry.lock{% endif %}' 23 | $(MAKE) clean 24 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | > **Note**: If you're looking for the old CookieCutter template, see [this branch](https://github.com/ThatXliner/pyt2/tree/cookiecutter) 2 | 3 | # Pyt2 4 | 5 | ![GitHub tag (latest SemVer release)](https://img.shields.io/github/v/tag/ThatXliner/pyt2?logo=Github&label=version) 6 | 7 | My [second attempt](https://github.com/ThatXliner/Pytemplate) at making a Python template. 8 | 9 | ## Why? 10 | 11 | I've seen [many other projects like this](https://github.com/search?q=python+cookiecutter) but I've never seen any of them follow the pattern I want. I highly recommend you [Fork This Project](https://github.com/ThatXliner/pyt2/fork) for your own needs because many of the defaults (e.g. README structure) are quite opinionated. 12 | 13 | ## :sparkles: Features 14 | 15 | - :open_file_folder: Package management 16 | - :musical_note: Uses [Poetry](https://python-poetry.org) to manage the project 17 | - :notes: Has [Poe](https://github.com/nat-n/poethepoet) tasks 18 | - :art: Linters (checked via GitHub Actions :octocat:) 19 | - :black_circle: [Black](https://github.com/psf/black) 20 | - :snake: [MyPy](https://github.com/python/mypy) 21 | - :zap: [Ruff](https://beta.ruff.rs/docs/) (which includes [`isort`](https://pycqa.github.io/isort/) and [Pylint](https://pylint.readthedocs.io/en/latest/) and [many, many others...](https://beta.ruff.rs/docs/rules/)) 22 | - :warning: Uses [`.pre-commit-config.yaml`](https://pre-commit.com/) 23 | - :mouse: Uses [`.editorconfig`](https://editorconfig.org/) 24 | - 🧪 [Hypothesis](https://hypothesis.works), [codecov](https://about.codecov.io/), and [Pytest](https://pytest.org) for testing 25 | - :octocat: Uses [GitHub Actions](https://github.com/features/actions) for CI 26 | - :white_check_mark: [Cached workflows](https://github.com/ThatXliner/pyt2/blob/9f7b3d982a023ec2bc475a26752f909a9a95a2ba/%7B%7B%20cookiecutter.pypi_name%20%7D%7D/.github/workflows/ci.yml#L24-L43) 27 | - :snake: Tests for **Python 3.8+** on **:penguin: Linux, :apple: Mac, and :checkered_flag: Windows**. 28 | - :bookmark: [Automatically generate and upload distribution files on tagged GitHub releases](https://github.com/ThatXliner/pyt2/blob/master/%7B%7B%20cookiecutter.pypi_name%20%7D%7D/.github/workflows/release.yml.jinja) 29 | - :cheese: Publish to PyPi with [Trusted Publishers](https://docs.pypi.org/trusted-publishers/) 30 | - (Optional) :smile_cat: Documentation via [Sphinx](https://www.sphinx-doc.org/en/master/) 31 | - :printer: Template usage features 32 | - :recycle: Pyt2 uses [Copier](https://copier.readthedocs.io/en/stable/), therefore Pyt2 has [template syncing features](https://copier.readthedocs.io/en/stable/updating/) 33 | - :lock: Pre-computed lockfile (`poetry.lock`) with up-to-date dependencies via CI ([![Autoupdate](https://github.com/ThatXliner/pyt2/actions/workflows/autoupdate.yml/badge.svg)](https://github.com/ThatXliner/pyt2/actions/workflows/autoupdate.yml)) 34 | - :bookmark: Has a `test_version.py` which will test if the `__version__` metadata variable in the package is equal to the one in the `pyproject.toml` 35 | - (Optional) :clapper: `__main__.py` and `[tool.poetry.scripts]` entry point generation (for applications) 36 | 37 | # Usage 38 | 39 | First, install [Copier](https://copier.readthedocs.io/en/stable/) (preferably using [pipx](https://pypa.github.io/pipx/)): 40 | 41 | ```bash 42 | pipx install copier 43 | ``` 44 | 45 | Now you can run this command to create a new folder in the current directory that contains the scaffolded project: 46 | 47 | ```bash 48 | copier copy gh:ThatXliner/pyt2 . 49 | ``` 50 | 51 | Or for the bleeding-edge version on the `master` branch: 52 | 53 | ```bash 54 | copier copy gh:ThatXliner/pyt2 . --vcs-ref master 55 | ``` 56 | 57 | ## Updating a project 58 | 59 | If you have already made a project using this and this template gets a new release, you may update your project by running 60 | 61 | ```bash 62 | copier update 63 | ``` 64 | 65 | in your project. 66 | 67 | # FAQ 68 | 69 | ## About the name... 70 | 71 | Pronunciation: _pit-too_ 72 | Why this is the name: **Py**thon **T**emplate **2** 73 | 74 | ## Why is the default templated license GPL? 75 | 76 | [Because it's usually better](https://thatxliner.github.io/blog/posts/why-i-use-gnu-gpl-v3/). 77 | 78 | But you can fork this and modify the default license in the template anyways. _This template_, however, is released to the **Public Domain**. 79 | -------------------------------------------------------------------------------- /copier.yml: -------------------------------------------------------------------------------- 1 | _min_copier_version: "9.1.0" 2 | _subdirectory: template 3 | # _jinja_extensions: 4 | # - "jinja2_slug.SlugExtension" 5 | project_name: 6 | type: "str" 7 | help: "A human-readable, official name for the project" 8 | placeholder: "Cool Example" 9 | validator: "{% if project_name|length == 0 %}Project name may not be empty{% endif %}" 10 | pypi_name: 11 | type: "str" 12 | help: "Your package name on PyPi" 13 | default: "{{ project_name|lower|replace(' ', '-') }}" 14 | # default: "{{ project_name|slug }}" 15 | module_name: 16 | type: "str" 17 | help: "`import` this project in Python using this name" 18 | default: "{{ pypi_name|replace('-', '_') }}" 19 | validator: "{% if not (module_name|regex_search('^[_a-zA-Z][_a-zA-Z0-9]+$')) %}Your module name is invalid{% endif %}" 20 | project_description: 21 | type: "str" 22 | help: "The description of the project as it appears on PyPi" 23 | placeholder: "An awesome project" 24 | add_docs: 25 | type: "bool" 26 | help: "Do you want to add docs to your project?" 27 | default: true 28 | is_app: 29 | type: "bool" 30 | help: "Is your project an app that you should run?" 31 | default: true 32 | author: 33 | type: "str" 34 | help: "The author name as it shows on PyPi" 35 | placeholder: "John Doe" 36 | validator: "{% if author|length == 0 %}Author name may not be empty{% endif %}" 37 | username: 38 | type: "str" 39 | help: "Your username as it is on GitHub" 40 | placeholder: "Octocat" 41 | validator: "{% if username|length == 0 %}Username may not be empty{% endif %}" 42 | email: 43 | type: "str" 44 | help: "Your email" 45 | placeholder: "hello@example.com" 46 | # init_venv: 47 | # type: "bool" 48 | # help: "Should we run `poetry install` for you?" 49 | # default: true 50 | # git_init: 51 | # type: "bool" 52 | # help: "Should we run `git init` for you?" 53 | # default: true 54 | # _tasks: 55 | # - "{% if init_venv %}poetry install{% endif %}" 56 | # - "{% if git_init %}git init{% endif %}" 57 | -------------------------------------------------------------------------------- /template/{{ pypi_name }}/.editorconfig: -------------------------------------------------------------------------------- 1 | # EditorConfig is awesome: https://EditorConfig.org 2 | 3 | # top-most EditorConfig file 4 | root = true 5 | 6 | [*] 7 | indent_style = space 8 | indent_size = 4 9 | end_of_line = lf 10 | charset = utf-8 11 | trim_trailing_whitespace = true 12 | insert_final_newline = true 13 | 14 | [*.{yml,yaml,md}] 15 | indent_size = 2 16 | 17 | [Makefile] 18 | indent_style = tab 19 | -------------------------------------------------------------------------------- /template/{{ pypi_name }}/.github/ISSUE_TEMPLATE/BUG_REPORT.yml: -------------------------------------------------------------------------------- 1 | name: 🐛 Bug Report 2 | description: File a bug report 3 | title: "[Bug]: " 4 | labels: ["bug"] 5 | body: 6 | - type: markdown 7 | attributes: 8 | value: | 9 | Thanks for taking the time to fill out this bug report! 🤗 10 | - type: checkboxes 11 | id: generic-bug-report-checklist 12 | attributes: 13 | label: Prerequisites 14 | description: "Before you continue make sure you have done all of the following:" 15 | options: 16 | - label: I have searched the [issues](../issues) and believe that it has not already been reported 17 | required: true 18 | - label: I have made sure this bug reproduces on the latest version 19 | required: true 20 | - label: "I agree to follow the [Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/)" 21 | required: true 22 | - type: textarea 23 | id: bug-info 24 | attributes: 25 | label: Bug description 26 | description: Also tell us, what did you expect to happen? 27 | placeholder: Tell us what you see! What did you think should've happened? 28 | value: "A bug happened! There shouldn't be!" 29 | validations: 30 | required: true 31 | - type: textarea 32 | id: repro 33 | attributes: 34 | label: Reproduction steps 35 | description: What are the steps that you took to create this bug? 36 | placeholder: | 37 | 1. In this environment... 38 | 2. With this config... 39 | 3. Run '...' 40 | 4. See error... 41 | value: "1. " 42 | validations: 43 | required: true 44 | - type: textarea 45 | id: other-info 46 | attributes: 47 | label: Other information 48 | description: Other additional information that may deem useful. If you're sending code, please make an [MCVE](https://stackoverflow.com/help/minimal-reproducible-example) 49 | placeholder: "Environment, OS, debug logs, etc." 50 | validations: 51 | required: false 52 | - type: input 53 | id: repro-how-often 54 | attributes: 55 | label: Reproduces how often 56 | description: What percentage of the time does it reproduce? 57 | placeholder: "100% of the time? 75% of the times? Only when I do X?" 58 | value: "I can reproduce this bug 100% of the time" 59 | validations: 60 | required: true 61 | -------------------------------------------------------------------------------- /template/{{ pypi_name }}/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml: -------------------------------------------------------------------------------- 1 | name: ✨ Feature request 2 | description: Request a new feature, or a change in an existing one. 3 | title: "[REQUEST]: " 4 | labels: ["enhancement"] 5 | body: 6 | - type: checkboxes 7 | id: generic-feature-request-checklist 8 | attributes: 9 | label: Prerequisites 10 | description: "Before you start, make sure you have done all of the following:" 11 | options: 12 | - label: I have searched the [issues](../issues) and believe that it has not already been requested (and possibly rejected) 13 | required: true 14 | - label: I have made sure that this feature isn't possible with this project's plugin system and/or configuration; core changes must be made to make this happen. 15 | required: true 16 | - label: "I agree to follow the [Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/)" 17 | required: true 18 | - type: textarea 19 | id: feature-info 20 | attributes: 21 | label: Feature description 22 | description: Describe the feature 23 | placeholder: Tell us what you want to happen, and why can't it happen with our project's current customization (if you want to request enhancements to the plugin system/configuration/customization system, please file a seperate feature request for that) 24 | value: "Example: I want X which does Y, and this is a core change/I can't do right now because of Z" 25 | validations: 26 | required: true 27 | -------------------------------------------------------------------------------- /template/{{ pypi_name }}/.github/workflows/ci.yml.jinja: -------------------------------------------------------------------------------- 1 | {% raw %}name: CI 2 | on: 3 | schedule: 4 | - cron: "0 0 1 * *" # Run every month 5 | # This way, we can make sure code doesn't break via external dependencies 6 | push: 7 | pull_request: 8 | env: 9 | POETRY_VERSION: 1.5.1 10 | jobs: 11 | test: 12 | strategy: 13 | matrix: 14 | python-version: 15 | - "3.12" 16 | os: [ubuntu-latest, macos-latest, windows-latest] 17 | runs-on: ${{ matrix.os }} 18 | steps: 19 | - name: Check out repository code 20 | uses: actions/checkout@v3 21 | - name: Set up Python ${{ matrix.python-version }} 22 | uses: actions/setup-python@v4 23 | with: 24 | python-version: ${{ matrix.python-version }} 25 | - uses: actions/cache@v3 26 | with: 27 | path: | 28 | .venv 29 | .pytest_cache 30 | key: ${{ runner.os }}-pip-${{ hashFiles('**/poetry.lock') }} 31 | restore-keys: | 32 | ${{ runner.os }}-pip- 33 | 34 | - name: Install Poetry and Poe (UNIX) 35 | if: runner.os != 'Windows' 36 | run: python3 -m pip install poetry==$POETRY_VERSION poethepoet 37 | - name: Install Poetry and Poe (Windows) 38 | if: runner.os == 'Windows' 39 | run: python -m pip install poetry==$env:POETRY_VERSION poethepoet 40 | 41 | - name: Install dependencies 42 | run: | 43 | poetry config virtualenvs.in-project true 44 | poetry install 45 | poetry install # Second time to install the project 46 | - name: Run test suite 47 | run: poe ci 48 | - name: Upload to CodeCov 49 | uses: codecov/codecov-action@v2{% endraw %}{% if add_docs %}{% raw %} 50 | docs: 51 | runs-on: ubuntu-latest 52 | steps: 53 | - name: Check out repository code 54 | uses: actions/checkout@v3 55 | - uses: actions/setup-python@v4 56 | with: 57 | python-version: 3 58 | - uses: actions/cache@v3 59 | with: 60 | path: .venv 61 | key: ${{ runner.os }}-pip-${{ hashFiles('**/poetry.lock') }} 62 | restore-keys: | 63 | ${{ runner.os }}-pip- 64 | 65 | - name: Install dependencies 66 | run: | 67 | python3 -m pip install --upgrade pip poetry==$POETRY_VERSION poethepoet 68 | poetry config virtualenvs.in-project true 69 | poetry install 70 | poetry install # Second time to install the project 71 | 72 | - name: Build docs 73 | run: poe docs{% endraw %}{% endif %}{% raw %} 74 | build: 75 | runs-on: ubuntu-latest 76 | steps: 77 | - name: Check out repository code 78 | uses: actions/checkout@v3 79 | - uses: actions/setup-python@v4 80 | with: 81 | python-version: 3 82 | - name: Install Poetry $POETRY_VERSION 83 | run: python3 -m pip install --upgrade pip poetry==$POETRY_VERSION 84 | - name: Build project 85 | run: poetry build 86 | lints: 87 | runs-on: ubuntu-latest 88 | steps: 89 | - name: Check out repository code 90 | uses: actions/checkout@v3 91 | - name: Set up Python 92 | uses: actions/setup-python@v4 93 | with: 94 | python-version: 3 95 | - uses: actions/cache@v3 96 | with: 97 | path: .venv 98 | key: ${{ runner.os }}-pip-${{ hashFiles('**/poetry.lock') }} 99 | restore-keys: | 100 | ${{ runner.os }}-pip- 101 | 102 | - name: Install dependencies 103 | run: | 104 | python3 -m pip install --upgrade pip poetry==$POETRY_VERSION poethepoet 105 | poetry config virtualenvs.in-project true 106 | poetry install 107 | poetry install # Second time to install the project 108 | 109 | - name: Run style lints 110 | run: poe style 111 | - name: Run ruff lints 112 | run: poe codebase 113 | - name: Run mypy lints 114 | run: poe mypy 115 | {% endraw %} 116 | -------------------------------------------------------------------------------- /template/{{ pypi_name }}/.github/workflows/release.yml.jinja: -------------------------------------------------------------------------------- 1 | {% raw %}name: Release And Upload 2 | on: 3 | release: 4 | types: 5 | - published 6 | jobs: 7 | build: 8 | runs-on: ubuntu-latest 9 | steps: 10 | - uses: actions/checkout@v4 11 | - uses: actions/setup-python@v5 12 | with: 13 | python-version: 3 14 | - name: Install Poetry 15 | uses: snok/install-poetry@v1 16 | - name: Build artifacts 17 | run: poetry build 18 | - name: Store the distribution packages 19 | uses: actions/upload-artifact@v4 20 | with: 21 | name: python-package-distributions 22 | path: dist/ 23 | add-release-assets: 24 | runs-on: ubuntu-latest 25 | permissions: 26 | id-token: write # IMPORTANT: mandatory for trusted publishing 27 | contents: write 28 | needs: 29 | - build 30 | steps: 31 | - name: Download all the dists 32 | uses: actions/download-artifact@v4 33 | with: 34 | name: python-package-distributions 35 | path: dist/ 36 | - name: Sign the dists with Sigstore 37 | uses: sigstore/gh-action-sigstore-python@v3.0.0 38 | with: 39 | inputs: >- 40 | ./dist/*.tar.gz 41 | ./dist/*.whl 42 | - name: Upload artifacts to release 43 | uses: shogo82148/actions-upload-release-asset@v1 44 | with: 45 | upload_url: ${{ github.event.release.upload_url }} 46 | asset_path: dist/* 47 | upload-to-pypi: 48 | runs-on: ubuntu-latest 49 | environment: 50 | name: pypi 51 | url: {% endraw %}https://pypi.org/p/{{ pypi_name }} 52 | permissions: 53 | id-token: write # IMPORTANT: mandatory for trusted publishing 54 | needs: 55 | - build 56 | steps: 57 | - name: Download all the dists 58 | uses: actions/download-artifact@v4 59 | with: 60 | name: python-package-distributions 61 | path: dist/ 62 | - name: Publish distribution 📦 to PyPI 63 | uses: pypa/gh-action-pypi-publish@release/v1 64 | -------------------------------------------------------------------------------- /template/{{ pypi_name }}/.gitignore: -------------------------------------------------------------------------------- 1 | .venv/ 2 | __pycache__/ 3 | .hypothesis/ 4 | .pytest_cache/ 5 | .DS_Store 6 | .mypy_cache/ 7 | .env 8 | htmlcov/ 9 | dist/ 10 | build/ 11 | .coverage* 12 | coverage.xml 13 | -------------------------------------------------------------------------------- /template/{{ pypi_name }}/.pre-commit-config.yaml: -------------------------------------------------------------------------------- 1 | repos: 2 | - repo: https://github.com/pre-commit/pre-commit-hooks 3 | rev: v4.4.0 4 | hooks: 5 | - id: check-yaml 6 | - id: check-json 7 | - id: check-toml 8 | - id: end-of-file-fixer 9 | - id: trailing-whitespace 10 | - repo: https://github.com/astral-sh/ruff-pre-commit 11 | rev: v0.0.272 12 | hooks: 13 | - id: ruff 14 | args: [--fix] 15 | -------------------------------------------------------------------------------- /template/{{ pypi_name }}/CODE_OF_CONDUCT.md.jinja: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | We as members, contributors, and leaders pledge to make participation in our 6 | community a harassment-free experience for everyone, regardless of age, body 7 | size, visible or invisible disability, ethnicity, sex characteristics, gender 8 | identity and expression, level of experience, education, socio-economic status, 9 | nationality, personal appearance, race, caste, color, religion, or sexual 10 | identity and orientation. 11 | 12 | We pledge to act and interact in ways that contribute to an open, welcoming, 13 | diverse, inclusive, and healthy community. 14 | 15 | ## Our Standards 16 | 17 | Examples of behavior that contributes to a positive environment for our 18 | community include: 19 | 20 | * Demonstrating empathy and kindness toward other people 21 | * Being respectful of differing opinions, viewpoints, and experiences 22 | * Giving and gracefully accepting constructive feedback 23 | * Accepting responsibility and apologizing to those affected by our mistakes, 24 | and learning from the experience 25 | * Focusing on what is best not just for us as individuals, but for the overall 26 | community 27 | 28 | Examples of unacceptable behavior include: 29 | 30 | * The use of sexualized language or imagery, and sexual attention or advances of 31 | any kind 32 | * Trolling, insulting or derogatory comments, and personal or political attacks 33 | * Public or private harassment 34 | * Publishing others' private information, such as a physical or email address, 35 | without their explicit permission 36 | * Other conduct which could reasonably be considered inappropriate in a 37 | professional setting 38 | 39 | ## Enforcement Responsibilities 40 | 41 | Community leaders are responsible for clarifying and enforcing our standards of 42 | acceptable behavior and will take appropriate and fair corrective action in 43 | response to any behavior that they deem inappropriate, threatening, offensive, 44 | or harmful. 45 | 46 | Community leaders have the right and responsibility to remove, edit, or reject 47 | comments, commits, code, wiki edits, issues, and other contributions that are 48 | not aligned to this Code of Conduct, and will communicate reasons for moderation 49 | decisions when appropriate. 50 | 51 | ## Scope 52 | 53 | This Code of Conduct applies within all community spaces, and also applies when 54 | an individual is officially representing the community in public spaces. 55 | Examples of representing our community include using an official e-mail address, 56 | posting via an official social media account, or acting as an appointed 57 | representative at an online or offline event. 58 | 59 | ## Enforcement 60 | 61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 62 | reported to the community leaders responsible for enforcement at 63 | [{{ email }}](mailto:{{ email }}). 64 | All complaints will be reviewed and investigated promptly and fairly. 65 | 66 | All community leaders are obligated to respect the privacy and security of the 67 | reporter of any incident. 68 | 69 | ## Enforcement Guidelines 70 | 71 | Community leaders will follow these Community Impact Guidelines in determining 72 | the consequences for any action they deem in violation of this Code of Conduct: 73 | 74 | ### 1. Correction 75 | 76 | **Community Impact**: Use of inappropriate language or other behavior deemed 77 | unprofessional or unwelcome in the community. 78 | 79 | **Consequence**: A private, written warning from community leaders, providing 80 | clarity around the nature of the violation and an explanation of why the 81 | behavior was inappropriate. A public apology may be requested. 82 | 83 | ### 2. Warning 84 | 85 | **Community Impact**: A violation through a single incident or series of 86 | actions. 87 | 88 | **Consequence**: A warning with consequences for continued behavior. No 89 | interaction with the people involved, including unsolicited interaction with 90 | those enforcing the Code of Conduct, for a specified period of time. This 91 | includes avoiding interactions in community spaces as well as external channels 92 | like social media. Violating these terms may lead to a temporary or permanent 93 | ban. 94 | 95 | ### 3. Temporary Ban 96 | 97 | **Community Impact**: A serious violation of community standards, including 98 | sustained inappropriate behavior. 99 | 100 | **Consequence**: A temporary ban from any sort of interaction or public 101 | communication with the community for a specified period of time. No public or 102 | private interaction with the people involved, including unsolicited interaction 103 | with those enforcing the Code of Conduct, is allowed during this period. 104 | Violating these terms may lead to a permanent ban. 105 | 106 | ### 4. Permanent Ban 107 | 108 | **Community Impact**: Demonstrating a pattern of violation of community 109 | standards, including sustained inappropriate behavior, harassment of an 110 | individual, or aggression toward or disparagement of classes of individuals. 111 | 112 | **Consequence**: A permanent ban from any sort of public interaction within the 113 | community. 114 | 115 | ## Attribution 116 | 117 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 118 | version 2.1, available at 119 | [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. 120 | 121 | Community Impact Guidelines were inspired by 122 | [Mozilla's code of conduct enforcement ladder][Mozilla CoC]. 123 | 124 | For answers to common questions about this code of conduct, see the FAQ at 125 | [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at 126 | [https://www.contributor-covenant.org/translations][translations]. 127 | 128 | [homepage]: https://www.contributor-covenant.org 129 | [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html 130 | [Mozilla CoC]: https://github.com/mozilla/diversity 131 | [FAQ]: https://www.contributor-covenant.org/faq 132 | [translations]: https://www.contributor-covenant.org/translations 133 | -------------------------------------------------------------------------------- /template/{{ pypi_name }}/CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | Hello! :wave: Thanks for taking the time to contribute. 4 | 5 | There are many ways you can contribute :smile: 6 | 7 | - [Pull Request](#pr) 8 | - 🩹 Submit an obvious fix (e.g. typo) 9 | - :memo: Work on a bug 10 | - [Submit an Issue](#issue) 11 | - :sparkles: Request a feature 12 | - :bug: Report a bug 13 | 14 | Remember to follow the [code of conduct](./CODE_OF_CONDUCT.md) 15 | 16 | We use [Poetry](https://python-poetry.org) to manage the project so [make sure you have it](https://python-poetry.org/docs/#installation). Once you do, set up the virtual environment after you cloned repo 17 | 18 | ``` 19 | $ poetry install 20 | ``` 21 | 22 | You can test locally with 23 | 24 | ``` 25 | $ poe test 26 | ``` 27 | 28 | Or (if you don't have [Poe the poet](https://github.com/nat-n/poethepoet)) 29 | 30 | ``` 31 | $ poetry run pytest 32 | ``` 33 | 34 |

Pull Request contributing guide

35 | 36 | Doing the following will *increase your chances* of your pull request to be accepted :+1: 37 | 38 | - Describe other considered solutions 39 | - Follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) or [Gitmoji](https://gitmoji.dev) commit style 40 | - For all code-related changes follow the [code style](#cs). Write [tests](#test-guide) if applicable 41 | - Link to the related issue. If there is none, please [make one](#issue) *or* maybe [the issue is obvious](#minor-pr). 42 | 43 |

Fixing an obvious issue

44 | 45 | If an issue's solution seems obvious or clear (like fixing a typo or link), you may directly create a PR. Remember to fill in the required forms. 46 | 47 |

Major PR

48 | 49 | If you're making somewhat bigger code changes please write tests if they don't exist already :test_tube:. 50 | 51 | If you're fixing a bug :bug:, please remember link to the applicable issue describing the bug like this (if it exists): 52 | 53 | ```md 54 | - #issue-number 55 | ``` 56 | 57 | like 58 | 59 | ```md 60 | - #42 61 | ``` 62 | 63 | If you're changing/adding documentation, the above isn't required. 64 | 65 | 66 | ### Test guide 67 | 68 | When making tests, try to use [Hypothesis](https://hypothesis.works) (if present in `[dev-dependancies]`) for [example data](https://hypothesis.readthedocs.io/en/latest/data.html) as much as possible. 69 | 70 | #### Pytest 71 | 72 | Please have descriptive test function names. Wrap them in a test class if they serve a similar purpose. There should be more than 1 test class per file. Otherwise, unwrap it from the class and instead put it in the file. 73 | 74 | For example, if you have 75 | 76 | ```py 77 | # test_connection.py 78 | 79 | class TestConnection: 80 | def test_can_con(self): ... 81 | def test_con_ends_gracefully(self):... 82 | ``` 83 | 84 | And `TestConnection` is the only class in the file, unwrap the tests like so 85 | 86 | ```py 87 | # test_connection.py 88 | 89 | def test_can_con():... 90 | def test_con_ends_gracefully():... 91 | ``` 92 | 93 | 96 | 97 |

Code Style

98 | 99 | We use the linters Black, Pylint, and MyPy. We use the formatters Black and Isort. 100 | 101 | You can easily fix your code's style with 102 | 103 | ``` 104 | $ poe format 105 | ``` 106 | 107 | or 108 | ``` 109 | $ shed {{ cookiecutter.module_name }}/**.py 110 | ``` 111 | 112 | You can run the linters via 113 | 114 | ``` 115 | $ poe lint 116 | ``` 117 | 118 | Try to follow [my recommended code style](https://github.com/ThatXliner/Significant-files/blob/main/PYTHON_STYLE.md) or [Google's Style Guide](https://google.github.io/styleguide/pyguide.html) 119 | 120 |

Creating an issue

121 | 122 | Please remember to fill out all the forms when making an issue :+1:. This includes but is not limited to 123 | 124 | - Describe the issue 125 | - Reproduction steps 126 | - System information (e.g. Python version) 127 | 128 | Or if it's a feature request :sparkles: (also not limited to) 129 | 130 | - Describe the feature 131 | - Why the feature cannot exist without changes to code 132 | - What the new feature might be useful for 133 | -------------------------------------------------------------------------------- /template/{{ pypi_name }}/LICENSE.txt: -------------------------------------------------------------------------------- 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 | -------------------------------------------------------------------------------- /template/{{ pypi_name }}/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | # Pull Request Check List 2 | 3 | 4 | **Applicable issues** 5 | 6 | 13 | 14 | **Description of PR** 15 | 16 | 17 | 18 | **Alternative designs considered** 19 | 20 | 21 | -------------------------------------------------------------------------------- /template/{{ pypi_name }}/README.md.jinja: -------------------------------------------------------------------------------- 1 | # {{ project_name }} 2 | 3 | [![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/) 4 | [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) 5 | [![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/) 6 | [![codecov](https://codecov.io/gh/{{ username }}/{{ pypi_name }}/branch/main/graph/badge.svg)](https://codecov.io/gh/{{ username }}/{{ pypi_name }}) 7 | {% if add_docs == "yes" %}[![Documentation Status](https://readthedocs.org/projects/{{ module*name.replace("*", "") }}/badge/?version=stable)](https://{{ module_name.replace("_", "") }}.readthedocs.io/en/stable/?badge=stable){% endif %} 8 | [![CI](https://github.com/{{ username }}/{{ pypi_name }}/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/{{ username }}/{{ pypi_name }}/actions/workflows/ci.yml) 9 | [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/{{ pypi_name }})](https://pypi.org/project/{{ pypi_name }}) 10 | [![PyPI](https://img.shields.io/pypi/v/{{ pypi_name }})](https://pypi.org/project/{{ pypi_name }}) 11 | [![PyPI - License](https://img.shields.io/pypi/l/{{ pypi_name }})](#license) 12 | 13 | > {{ project_description }} 14 | 15 | ## Installation 16 | 17 | You can get this project via `pip` 18 | 19 | ```bash 20 | $ pip install {{ pypi_name }} 21 | ``` 22 | 23 | {% if is_app %} 24 | But we **highly recommend** you install this project using [pipx](https://pypa.github.io/pipx/) 25 | 26 | ```bash 27 | $ pipx install {{ pypi_name }} 28 | ``` 29 | 30 | {% else %} 31 | Or, if you're using [Poetry](https://python-poetry.org) 32 | 33 | ```bash 34 | $ poetry add {{ pypi_name }} 35 | ``` 36 | 37 | {% endif %} 38 | 39 | ## License 40 | 41 | This project is licensed under the [GNU GPL v3+](https://github.com/{{ username }}/{{ pypi_name }}/blob/main/LICENSE.txt). 42 | 43 | In short, this means you can do anything with it (distribute, modify, sell), but if you were to publish your changes, you must make the source code and build instructions readily available. 44 | 45 | If you are a company using this project and want an exception, email me at [{{ email }}](mailto:{{ email }}), and we can discuss it. 46 | -------------------------------------------------------------------------------- /template/{{ pypi_name }}/pyproject.toml.jinja: -------------------------------------------------------------------------------- 1 | [tool.poetry] 2 | name = "{{ pypi_name }}" 3 | description = "{{ project_description }}" 4 | authors = ["{{ author }}{% if email|length != 0 %} <{{ email }}>{% endif %}"] 5 | version = "0.1.0" 6 | 7 | readme = "README.md" 8 | license = "GPL-3.0-or-later" 9 | 10 | classifiers = [ 11 | # Get the list of trove classifiers here: https://pypi.org/classifiers/ 12 | "Programming Language :: Python :: Implementation :: CPython", 13 | "Typing :: Typed", 14 | "Operating System :: OS Independent", 15 | "Development Status :: 4 - Beta", 16 | "Natural Language :: English", 17 | ]{% if add_docs %} 18 | documentation = "https://{{ module_name.replace('_', '') }}.readthedocs.io/en/latest/index.html"{% endif %} 19 | homepage = "https://github.com/{{ username }}/{{ pypi_name }}" 20 | # keywords = ["awesome", "project"] # Maximum of 5 keywords 21 | 22 | [tool.poetry.dependencies] 23 | python = "^3.12"{% if is_app %} 24 | 25 | [tool.poetry.scripts] 26 | {{ module_name }} = "{{ module_name }}.__main__:main" 27 | {% endif %} 28 | 29 | [tool.poetry.group.dev.dependencies] 30 | black = "^23.1.0" 31 | hypothesis = "^6.68.2" 32 | mypy = "^1.0.1" 33 | pytest = "^7.2.1" 34 | pytest-clarity = "^1.0.1" 35 | pytest-cov = "^4.0.0" 36 | ruff = "^0.2.2" 37 | shed = "^0.10.9" 38 | {% if add_docs %} 39 | Sphinx = "^6.1.3"{% endif %} 40 | toml = "^0.10.2" 41 | 42 | [tool.poe.tasks] 43 | # Code linting 44 | mypy = {cmd = "mypy {{ module_name }} --strict", help = "Run MyPy on codebase"} 45 | ruff = {cmd = "ruff check {{ module_name }}", help = "Run Ruff on codebase"} 46 | check_black = {cmd = "black {{ module_name }} --check"} 47 | check_imports = {cmd = "ruff check {{ module_name }} --select I"} 48 | style = ["check_black", "check_imports"] 49 | codebase = ["ruff", "mypy"]{% if add_docs %} 50 | [tool.poe.tasks.docs] 51 | cmd = "sphinx-build docs build" 52 | help = "Build documentation"{% endif %} 53 | 54 | [tool.poe.tasks.format] 55 | cmd = "shed" 56 | help = "Format code" 57 | 58 | [tool.poe.tasks.fix-ruff] 59 | cmd = "ruff {{ module_name }} --fix" 60 | help = "Ruff autofix" 61 | 62 | [tool.poe.tasks.lint] 63 | sequence = ["style", "codebase"] 64 | help = "Lint codebase" 65 | 66 | [tool.poe.tasks.test] 67 | cmd = "pytest -vvv --cov={{ module_name }}" 68 | help = "Simply run test suite" 69 | 70 | [tool.poe.tasks.ci] 71 | cmd = "pytest -vvv --cov={{ module_name }} --cov-report=xml" 72 | help = "This workflow is for Github Actions" 73 | 74 | 75 | [build-system] 76 | requires = ["poetry-core>=1.0.0"] 77 | build-backend = "poetry.core.masonry.api" 78 | 79 | [tool.ruff] 80 | # Same as Black. 81 | line-length = 88 82 | target-version = "py38" 83 | [tool.ruff.lint] 84 | select = ["ALL"] 85 | ignore = [ 86 | # "D", # "No docs" 87 | "T20", # "Don't use print or pprint" 88 | # "ANN", # Type annotation errors (or the lack of it) 89 | "ANN101", # The type annotation for `self` is inferred{% if is_app %} 90 | "FBT", # Disallow "boolean trap" to encourage better library APIs{% endif %} 91 | "PIE790", # "Unnecessary `...`" 92 | # Fix doc rule conflicts 93 | "D203", 94 | "D213" 95 | ] 96 | [tool.ruff.lint.per-file-ignores] 97 | "tests/**/*.py" = ["S101", "D"] 98 | "docs/conf.py" = ["INP001", "A001"] 99 | 100 | [tool.pyright] 101 | venvPath = "." 102 | venv = ".venv" 103 | -------------------------------------------------------------------------------- /template/{{ pypi_name }}/tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ThatXliner/pyt2/b16c7161cd99a7cff0705bd6957c2d61e90dccf7/template/{{ pypi_name }}/tests/__init__.py -------------------------------------------------------------------------------- /template/{{ pypi_name }}/tests/test_version.py.jinja: -------------------------------------------------------------------------------- 1 | from pathlib import Path 2 | 3 | import toml 4 | 5 | from {{ module_name }} import __version__ 6 | 7 | project_dir = Path(__file__).parent.parent 8 | 9 | 10 | def test_version(): 11 | assert ( 12 | __version__ 13 | == toml.loads(project_dir.joinpath("pyproject.toml").read_text())["tool"][ 14 | "poetry" 15 | ]["version"] 16 | ) 17 | -------------------------------------------------------------------------------- /template/{{ pypi_name }}/{% if add_docs %}.readthedocs.yaml{% endif %}: -------------------------------------------------------------------------------- 1 | # Required 2 | version: 2 3 | python: 4 | install: 5 | - requirements: docs/requirements.txt 6 | build: 7 | os: ubuntu-22.04 8 | tools: 9 | python: "3.12" 10 | -------------------------------------------------------------------------------- /template/{{ pypi_name }}/{% if add_docs %}docs{% endif %}/conf.py.jinja: -------------------------------------------------------------------------------- 1 | # Configuration file for the Sphinx documentation builder. 2 | # 3 | # This file only contains a selection of the most common options. For a full 4 | # list see the documentation: 5 | # https://www.sphinx-doc.org/en/master/usage/configuration.html 6 | 7 | # -- Path setup -------------------------------------------------------------- 8 | 9 | # If extensions (or modules to document with autodoc) are in another directory, 10 | # add these directories to sys.path here. If the directory is relative to the 11 | # documentation root, use os.path.abspath to make it absolute, like shown here. 12 | # 13 | # import os 14 | # import sys 15 | # sys.path.insert(0, os.path.abspath('.')) 16 | 17 | 18 | # -- Project information ----------------------------------------------------- 19 | from {{ module_name }} import __version__ 20 | 21 | project = "{{ project_name }}" 22 | copyright = "2022, {{ author }}" 23 | author = "{{ author }}" 24 | 25 | # The full version, including alpha/beta/rc tags 26 | release = __version__ 27 | 28 | # -- General configuration --------------------------------------------------- 29 | 30 | # Add any Sphinx extension module names here, as strings. They can be 31 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 32 | # ones. 33 | extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon"] 34 | 35 | # Add any paths that contain templates here, relative to this directory. 36 | templates_path = [] 37 | 38 | # List of patterns, relative to source directory, that match files and 39 | # directories to ignore when looking for source files. 40 | # This pattern also affects html_static_path and html_extra_path. 41 | exclude_patterns = [] 42 | 43 | 44 | # -- Options for HTML output ------------------------------------------------- 45 | 46 | # The theme to use for HTML and HTML Help pages. See the documentation for 47 | # a list of builtin themes. 48 | # 49 | html_theme = "alabaster" 50 | 51 | # Add any paths that contain custom static files (such as style sheets) here, 52 | # relative to this directory. They are copied after the builtin static files, 53 | # so a file named "default.css" will overwrite the builtin "default.css". 54 | html_static_path = [] 55 | -------------------------------------------------------------------------------- /template/{{ pypi_name }}/{% if add_docs %}docs{% endif %}/index.rst.jinja: -------------------------------------------------------------------------------- 1 | Welcome to {{ project_name }}'s documentation! 2 | ==========={% for _ in project_name %}={% endfor %}================= 3 | 4 | .. toctree:: 5 | :maxdepth: 2 6 | :caption: Contents: 7 | 8 | 9 | 10 | Indices and tables 11 | ================== 12 | 13 | * :ref:`genindex` 14 | * :ref:`modindex` 15 | * :ref:`search` 16 | -------------------------------------------------------------------------------- /template/{{ pypi_name }}/{% if add_docs %}docs{% endif %}/requirements.txt.jinja: -------------------------------------------------------------------------------- 1 | Sphinx 2 | {{ pypi_name }} 3 | -------------------------------------------------------------------------------- /template/{{ pypi_name }}/{{ _copier_conf.answers_file }}.jinja: -------------------------------------------------------------------------------- 1 | # Changes here will be overwritten by Copier; NEVER EDIT MANUALLY 2 | {{ _copier_answers|to_nice_yaml -}} 3 | -------------------------------------------------------------------------------- /template/{{ pypi_name }}/{{ module_name }}/__init__.py.jinja: -------------------------------------------------------------------------------- 1 | """{{ project_description }}""" 2 | __version__ = "0.1.0" 3 | -------------------------------------------------------------------------------- /template/{{ pypi_name }}/{{ module_name }}/py.typed: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ThatXliner/pyt2/b16c7161cd99a7cff0705bd6957c2d61e90dccf7/template/{{ pypi_name }}/{{ module_name }}/py.typed -------------------------------------------------------------------------------- /template/{{ pypi_name }}/{{ module_name }}/{% if is_app %}__main__.py{% endif %}.jinja: -------------------------------------------------------------------------------- 1 | """The main CLI entry point.""" 2 | 3 | 4 | def main() -> None: 5 | """Run the app.""" 6 | ... 7 | 8 | 9 | if __name__ == "__main__": 10 | main() 11 | --------------------------------------------------------------------------------