diff --git a/.apidoc_conf.py b/.apidoc_conf.py index 172055e..4c79cd9 100644 --- a/.apidoc_conf.py +++ b/.apidoc_conf.py @@ -1,5 +1,5 @@ # -- Project information ----------------------------------------------------- -project = "{{project_name}}" +project = "cookie-doh" copyright = "microsoft" author = "microsoft research" diff --git a/.apidoc_conf.py.jinja b/.apidoc_conf.py.jinja deleted file mode 120000 index ab18855..0000000 --- a/.apidoc_conf.py.jinja +++ /dev/null @@ -1 +0,0 @@ -.apidoc_conf.py \ No newline at end of file diff --git a/.azure-pipelines/cg.yml b/.azure-pipelines/cg.yml index 9b06912..f66efc1 100644 --- a/.azure-pipelines/cg.yml +++ b/.azure-pipelines/cg.yml @@ -2,7 +2,7 @@ trigger: [main] pr: [main] schedules: - cron: "0 0 * * 1" - displayName: "Weekly: {{project_name}}" + displayName: "Weekly: cookie-doh" branches: include: - main diff --git a/.azure-pipelines/cg.yml.jinja b/.azure-pipelines/cg.yml.jinja deleted file mode 120000 index f266c92..0000000 --- a/.azure-pipelines/cg.yml.jinja +++ /dev/null @@ -1 +0,0 @@ -cg.yml \ No newline at end of file diff --git a/.azure-pipelines/cg.yml.jinja b/.azure-pipelines/cg.yml.jinja new file mode 100644 index 0000000..9b06912 --- /dev/null +++ b/.azure-pipelines/cg.yml.jinja @@ -0,0 +1,19 @@ +trigger: [main] +pr: [main] +schedules: + - cron: "0 0 * * 1" + displayName: "Weekly: {{project_name}}" + branches: + include: + - main +pool: + vmImage: ubuntu-latest +variables: + EnableDetectorPoetry: true +steps: + - task: ComponentGovernanceComponentDetection@0 + inputs: + showAlertLink: true + failOnAlert: true + failOnStderr: true + logLevel: debug diff --git a/.coveragerc b/.coveragerc index 748b7ac..24afec6 100644 --- a/.coveragerc +++ b/.coveragerc @@ -1,7 +1,7 @@ [run] branch = True data_file = .tmp/.coverage -source = src/python/{{module_name}} +source = src relative_files = true [report] diff --git a/.coveragerc.jinja b/.coveragerc.jinja deleted file mode 120000 index 75d9b81..0000000 --- a/.coveragerc.jinja +++ /dev/null @@ -1 +0,0 @@ -.coveragerc \ No newline at end of file diff --git a/.devcontainer/on-create.sh b/.devcontainer/on-create.sh index 63521c5..ef72dc4 100755 --- a/.devcontainer/on-create.sh +++ b/.devcontainer/on-create.sh @@ -9,7 +9,7 @@ echo 'eval "$(direnv hook zsh)"' >> ~/.zshrc echo 'eval "$(direnv hook bash)"' >> ~/.bashrc eval "$(direnv hook bash)" mkdir -p ~/.config/direnv/ -cp /workspaces/{{project_name}}/.devcontainer/direnvrc ~/.config/direnv/direnvrc +cp /workspaces/cookie-doh/.devcontainer/direnvrc ~/.config/direnv/direnvrc echo "UPDATE PIP" pip install --upgrade pip diff --git a/.devcontainer/on-create.sh.jinja b/.devcontainer/on-create.sh.jinja deleted file mode 120000 index 1c0169a..0000000 --- a/.devcontainer/on-create.sh.jinja +++ /dev/null @@ -1 +0,0 @@ -on-create.sh \ No newline at end of file diff --git a/.devcontainer/on-create.sh.jinja b/.devcontainer/on-create.sh.jinja new file mode 100755 index 0000000..ed97796 --- /dev/null +++ b/.devcontainer/on-create.sh.jinja @@ -0,0 +1,33 @@ +#! /bin/bash +# this runs ONCE at devcontainer creation time, and it runs during pre-build phase which +# means it does not have access to user context +# =========================== + +# finish config of direnv settings (would be nice to improve the devcontainer "feature") +echo "CONFIGURING DIRENV..." +echo 'eval "$(direnv hook zsh)"' >> ~/.zshrc +echo 'eval "$(direnv hook bash)"' >> ~/.bashrc +eval "$(direnv hook bash)" +mkdir -p ~/.config/direnv/ +cp /workspaces/{{ project_name }}/.devcontainer/direnvrc ~/.config/direnv/direnvrc + +echo "UPDATE PIP" +pip install --upgrade pip + +{% if commitizen -%} +echo "INSTALLING COMMITIZEN" +pipx install commitizen +pipx inject commitizen cz-conventional-gitmoji +echo 'eval "$(register-python-argcomplete cz)"' >> ~/.zshrc +echo 'eval "$(register-python-argcomplete cz)"' >> ~/.bashrc +{%- endif %} + +echo "POETRY INSTALL" +poetry config virtualenvs.in-project true +direnv allow . +poetry install + +{% if precommit -%} +echo "CONFIGURING PRE-COMMIT" +pre-commit install --install-hooks +{%- endif %} diff --git a/.dockerignore b/.dockerignore index 8de5e22..fccfeb9 100644 --- a/.dockerignore +++ b/.dockerignore @@ -10,7 +10,7 @@ **/.vscode **/*.pyc -**/src/python/*.egg-info +**/src/*.egg-info **/build/ **/dist diff --git a/.gitignore b/.gitignore index ccbff65..9e70211 100644 --- a/.gitignore +++ b/.gitignore @@ -13,11 +13,8 @@ # ignore personal workspace files **/*.code-workspace -!{{project_name}}.code-workspace -{% if false %} # template files are excluded from copied repos !cookie-doh.code-workspace -!cookie-doh.code-workspace.jinja -{% endif %} + **/.vscode/* !**/.vscode/launch.json !**/.vscode/settings.json diff --git a/.gitignore.jinja b/.gitignore.jinja deleted file mode 120000 index 3e4e48b..0000000 --- a/.gitignore.jinja +++ /dev/null @@ -1 +0,0 @@ -.gitignore \ No newline at end of file diff --git a/README.md b/README.md index 4e6b49a..ae85a4e 100644 --- a/README.md +++ b/README.md @@ -5,31 +5,24 @@ [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -{{project_name}} info +Cookie-doh info +

+:point_right: Short-link: https://aka.ms/cookie-doh +

----------------------------------------------------------------- ## :notebook_with_decorative_cover: Documentation -https://{{organization}}.github.io/{{project_name}} +https://microsoft.github.io/cookie-doh - -## :rocket: Getting Started - - - -*Description of how to install and use the code or content goes here* - +## :rocket: Getting Started ### Optional system dependencies @@ -39,9 +32,13 @@ We use the following optional dependencies for development: * [direnv](https://direnv.net/): To manage environment variables and load python virtual environments automatically. * [pyenv](https://github.com/pyenv/pyenv): To manage python versions. * [pipx](https://pipxproject.github.io/pipx/): To install python packages in isolated environments. +{% if commitizen -%} * [commitizen](https://commitizen-tools.github.io/commitizen/): To help with [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/). * [cz-conventional-gitmoji](https://github.com/ljnsn/cz-conventional-gitmoji): A commitizen plugin that combines gitmoji and conventional commits. +{%- endif %} +{% if precommit -%} * [pre-commit](https://pre-commit.com/): To run code formatting and linting before committing. +{%- endif %} ### Required system dependencies @@ -73,111 +70,9 @@ Learn about [GitHub Codespaces](https://docs.github.com/en/codespaces) and/or [D [![Open in DevPod!](https://devpod.sh/assets/open-in-devpod.svg)](https://devpod.sh/open#https://github.com/{{organization}}/{{project_name}}) - - - - -### Installing - - -This repository does not hold installable content. - - - - - - - - - - - - - - -### Deployment (CI/CD) - - - - -_At this time, the repository does not use continuous integration or produce a website, artifact, or anything deployed._ - - - - - - - - - - - - -------------------------------------------- - -## :memo: Guide to using GitHub inside Microsoft - -You can find information on using GitHub inside Microsoft at [aka.ms/gim](https://aka.ms/gim). - -
- Expand for links to common tasks - -- [Switching between EMU GitHub and normal GitHub without logging out and back in constantly](https://aka.ms/StartRight/README-Template/maintainingMultipleAccount) -- [Creating a repository](https://aka.ms/StartRight) -- [Changing repository visibility](https://aka.ms/StartRight/README-Template/policies/jit) -- [Gaining repository permissions, access, and roles](https://aka.ms/StartRight/README-TEmplates/gim/policies/access) -- [Enabling easy access to your low sensitivity and widely applicable repository by setting it to Internal Visibility and having any FTE who wants to see it join the 1ES Enterprise Visibility MyAccess Group](https://aka.ms/StartRight/README-Template/gim/innersource-access) -- [Migrating repositories](https://aka.ms/StartRight/README-Template/troubleshoot/migration) -- [Setting branch protection](https://aka.ms/StartRight/README-Template/gim/policies/branch-protection) -- [Setting up GitHubActions](https://aka.ms/StartRight/README-Template/policies/actions) -- [and other actions](https://aka.ms/StartRight/README-Template/gim/policies) - -
- - ## :mountain: Contributing This project welcomes contributions and suggestions. Most contributions require you to agree to a @@ -200,6 +95,3 @@ trademarks or logos is subject to and must follow [Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general). Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies. - - - diff --git a/README.md.jinja b/README.md.jinja deleted file mode 120000 index 42061c0..0000000 --- a/README.md.jinja +++ /dev/null @@ -1 +0,0 @@ -README.md \ No newline at end of file diff --git a/SUPPORT.md b/SUPPORT.md index 44dcbc5..6f653fc 100644 --- a/SUPPORT.md +++ b/SUPPORT.md @@ -1,25 +1,23 @@ -# TODO: The maintainer of this repo has not yet edited this file - -**REPO OWNER**: Do you want Customer Service & Support (CSS) support for this product/project? - -- **No CSS support:** Fill out this template with information about how to file issues and get help. -- **Yes CSS support:** Fill out an intake form at [aka.ms/onboardsupport](https://aka.ms/onboardsupport). CSS will work with/help you to determine next steps. -- **Not sure?** Fill out an intake as though the answer were "Yes". CSS will help you decide. - -*Then remove this first heading from this SUPPORT.MD file before publishing your repo.* - -# Support - -## How to file issues and get help - -This project uses GitHub Issues to track bugs and feature requests. Please search the existing -issues before filing new issues to avoid duplicates. For new issues, file your bug or -feature request as a new Issue. - -For help and questions about using this project, please **REPO MAINTAINER: INSERT INSTRUCTIONS HERE -FOR HOW TO ENGAGE REPO OWNERS OR COMMUNITY FOR HELP. COULD BE A STACK OVERFLOW TAG OR OTHER -CHANNEL. WHERE WILL YOU HELP PEOPLE?**. - -## Microsoft Support Policy - -Support for this **PROJECT or PRODUCT** is limited to the resources listed above. +# TODO: The maintainer of this repo has not yet edited this file + +**REPO OWNER**: Do you want Customer Service & Support (CSS) support for this product/project? + +- **No CSS support:** Fill out this template with information about how to file issues and get help. +- **Yes CSS support:** Fill out an intake form at [aka.ms/onboardsupport](https://aka.ms/onboardsupport). CSS will work with/help you to determine next steps. +- **Not sure?** Fill out an intake as though the answer were "Yes". CSS will help you decide. + +*Then remove this first heading from this SUPPORT.MD file before publishing your repo.* + +# Support + +## How to file issues and get help + +This project uses GitHub Issues to track bugs and feature requests. Please search the existing +issues before filing new issues to avoid duplicates. For new issues, file your bug or +feature request as a new Issue. + +For help and questions about using this project, please use the "Discussions" tab in the repository. + +## Microsoft Support Policy + +Support for this **PROJECT or PRODUCT** is limited to the resources listed above. diff --git a/bin/docs-api b/bin/docs-api index f836a28..1fd055c 100755 --- a/bin/docs-api +++ b/bin/docs-api @@ -4,7 +4,7 @@ set -e rm -rf dist/sphinx-apidoc mkdir -p dist/sphinx-apidoc cp .apidoc_conf.py dist/sphinx-apidoc/conf.py -poetry run sphinx-apidoc --doc-project="{{project_name}}" --tocfile=index --implicit-namespaces --module-first --output-dir=dist/sphinx-apidoc --templatedir=dist/sphinx-apidoc-templates "src/python/{{module_name}}" +poetry run sphinx-apidoc --doc-project="cookie-doh" --tocfile=index --implicit-namespaces --module-first --output-dir=dist/sphinx-apidoc --templatedir=dist/sphinx-apidoc-templates "src/cookie" rm -rf dist/sphinx-markdown docs/api poetry run sphinx-build -M markdown dist/sphinx-apidoc dist/sphinx-markdown diff --git a/bin/docs-api.jinja b/bin/docs-api.jinja deleted file mode 120000 index 3d8a0b7..0000000 --- a/bin/docs-api.jinja +++ /dev/null @@ -1 +0,0 @@ -docs-api \ No newline at end of file diff --git a/cookie-doh.code-workspace b/cookie-doh.code-workspace index f4fbc7a..8975acd 100644 --- a/cookie-doh.code-workspace +++ b/cookie-doh.code-workspace @@ -53,10 +53,10 @@ "python.analysis.typeCheckingMode": "basic", "python.analysis.autoImportCompletions": true, "python.analysis.extraPaths": [ - "${workspaceFolder}/src/python" + "${workspaceFolder}/src" ], "python.autoComplete.extraPaths": [ - "${workspaceFolder}/src/python" + "${workspaceFolder}/src" ], "python.analysis.inlayHints.pytestParameters": true, "python.defaultInterpreterPath": ".venv/bin/python", diff --git a/copier.yml b/copier.yml index 02700d2..18d3485 100644 --- a/copier.yml +++ b/copier.yml @@ -4,6 +4,7 @@ organization: help: | GitHub organization or username for this repository. E.g., "microsoft", "your_username", "your_organization", etc. + default: microsoft project_name: type: str @@ -22,10 +23,48 @@ module_name: project_name must start with a letter, followed by one or more letters, digits or underscores. {% endif %} - repo_exists: - type: bool - help: Does this repository already exist on GitHub? - default: false +documentation: + type: bool + help: | + Do you want to include documentation in your project? + This will add a `docs` directory with a basic `sphinx` setup and CI builds. + default: true + +precommit: + type: bool + help: | + Do you want to include pre-commit hooks in your project? + This will add a `.pre-commit-config.yaml` file with some basic hooks. + default: true + +commitizen: + type: bool + help: | + Do you want to include commitizen in your project? + This will add a `.cz.toml` file and `commitizen` hooks to .pre-commit-config.yaml (if used). + default: true + +microsoft_internal: + type: bool + help: If the project belongs to a Microsoft internal organization + when: "{{ false }}" + default: "{{ organization in ['microsoft', 'technology-and-research', 'health-futures', 'ai4science'] }}" + +license: + type: str + when: "{{not microsoft_internal}}" + help: | + What is the copyright holder for the generated LICENSE? Your Name, Your Organization, etc. + default: "{% if not microsoft_internal %}{{organization}}{% else %}Microsoft Corporation{% endif %}" + +repo_exists: + type: bool + help: | + Does this repository already exist on GitHub? This question will give you instructions + create your repository on GitHub later on. + default: false + +_subdirectory: template _exclude: - CHANGELOG.md @@ -50,6 +89,7 @@ _message_after_copy: | 1. Pull repository into your newly created project: $ cd {{ _copier_conf.dst_path }} + $ git init $ git remote add origin https://github.com/{{ organization }}/{{ project_name }}.git $ git pull origin main # and resolve any conflicts @@ -70,7 +110,7 @@ _message_after_copy: | $ poetry add # optional $ poetry install - 3. Add the project's outputs, configure pre-commit and commit your changes: + 3. Add the project outputs, configure pre-commit and commit your changes: $ git add . $ pre-commit install --install-hooks diff --git a/docs/index.md b/docs/index.md index 2b62cd4..af56f9a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1 +1 @@ -# :cookie: {{project_name}} +# :sparkles: {{project_name}} diff --git a/mkdocs.yml b/mkdocs.yml index 1f57bcb..8ba5e0f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,6 +1,6 @@ -site_name: "{{project_name}}" -repo_url: https://github.com/{{organization}}/{{project_name}} -repo_name: "{{project_name}}" +site_name: "cookie-doh" +repo_url: https://github.com/microsoft/cookie-doh +repo_name: "cookie-doh" docs_dir: docs theme: name: material @@ -40,8 +40,8 @@ theme: extra_css: - css/extra.css # removed because of codeql detection -# https://github.com/{{organization}}/{{project_name}}/security/code-scanning/3 -# https://github.com/{{organization}}/{{project_name}}/security/code-scanning/4 +# https://github.com/microsoft/cookie-doh/security/code-scanning/3 +# https://github.com/microsoft/cookie-doh/security/code-scanning/4 #extra_javascript: # - js/mathjax.js # - js/tex-mml-chtml.js @@ -77,8 +77,8 @@ markdown_extensions: - pymdownx.tasklist: # Allows us to make a Tasklist: [x] some checked thing custom_checkbox: true # removed because of codeql detection - # https://github.com/{{organization}}/{{project_name}}/security/code-scanning/3 - # https://github.com/{{organization}}/{{project_name}}/security/code-scanning/4 + # https://github.com/microsoft/cookie-doh/security/code-scanning/3 + # https://github.com/microsoft/cookie-doh/security/code-scanning/4 # - pymdownx.arithmatex: # generic: true # Needed because sphinx is generating lists with 2 spaces which is not supported by mkdocs diff --git a/mkdocs.yml.jinja b/mkdocs.yml.jinja deleted file mode 120000 index 4e5c1cc..0000000 --- a/mkdocs.yml.jinja +++ /dev/null @@ -1 +0,0 @@ -mkdocs.yml \ No newline at end of file diff --git a/poetry.lock b/poetry.lock index b1545fa..dc50e6f 100644 --- a/poetry.lock +++ b/poetry.lock @@ -42,13 +42,13 @@ test = ["astroid (>=1,<2)", "astroid (>=2,<4)", "pytest"] [[package]] name = "babel" -version = "2.14.0" +version = "2.15.0" description = "Internationalization utilities" optional = false -python-versions = ">=3.7" +python-versions = ">=3.8" files = [ - {file = "Babel-2.14.0-py3-none-any.whl", hash = "sha256:efb1a25b7118e67ce3a259bed20545c29cb68be8ad2c784c83689981b7a57287"}, - {file = "Babel-2.14.0.tar.gz", hash = "sha256:6919867db036398ba21eb5c7a0f6b28ab8cbc3ae7a73a44ebe34ae74a4e7d363"}, + {file = "Babel-2.15.0-py3-none-any.whl", hash = "sha256:08706bdad8d0a3413266ab61bd6c34d0c28d6e1e7badf40a2cebe67644e2e1fb"}, + {file = "babel-2.15.0.tar.gz", hash = "sha256:8daf0e265d05768bc6c7a314cf1321e9a123afc328cc635c18622a2f30a04413"}, ] [package.extras] @@ -1247,17 +1247,16 @@ files = [ [[package]] name = "pygments" -version = "2.17.2" +version = "2.18.0" description = "Pygments is a syntax highlighting package written in Python." optional = false -python-versions = ">=3.7" +python-versions = ">=3.8" files = [ - {file = "pygments-2.17.2-py3-none-any.whl", hash = "sha256:b27c2826c47d0f3219f29554824c30c5e8945175d888647acd804ddd04af846c"}, - {file = "pygments-2.17.2.tar.gz", hash = "sha256:da46cec9fd2de5be3a8a784f434e4c4ab670b4ff54d605c4c2717e9d49c4c367"}, + {file = "pygments-2.18.0-py3-none-any.whl", hash = "sha256:b8e6aca0523f3ab76fee51799c488e38782ac06eafcf95e7ba832985c8e7b13a"}, + {file = "pygments-2.18.0.tar.gz", hash = "sha256:786ff802f32e91311bff3889f6e9a86e81505fe99f2735bb6d60ae0c5004f199"}, ] [package.extras] -plugins = ["importlib-metadata"] windows-terminal = ["colorama (>=0.4.6)"] [[package]] @@ -1280,13 +1279,13 @@ extra = ["pygments (>=2.12)"] [[package]] name = "pyright" -version = "1.1.361" +version = "1.1.362" description = "Command line wrapper for pyright" optional = false python-versions = ">=3.7" files = [ - {file = "pyright-1.1.361-py3-none-any.whl", hash = "sha256:c50fc94ce92b5c958cfccbbe34142e7411d474da43d6c14a958667e35b9df7ea"}, - {file = "pyright-1.1.361.tar.gz", hash = "sha256:1d67933315666b05d230c85ea8fb97aaa2056e4092a13df87b7765bb9e8f1a8d"}, + {file = "pyright-1.1.362-py3-none-any.whl", hash = "sha256:969957cff45154d8a45a4ab1dae5bdc8223d8bd3c64654fa608ab3194dfff319"}, + {file = "pyright-1.1.362.tar.gz", hash = "sha256:6a477e448d4a07a6a0eab58b2a15a1bbed031eb3169fa809edee79cca168d83a"}, ] [package.dependencies] @@ -1531,90 +1530,90 @@ cffi = {version = "*", markers = "implementation_name == \"pypy\""} [[package]] name = "regex" -version = "2024.4.28" +version = "2024.5.10" description = "Alternative regular expression module, to replace re." optional = false python-versions = ">=3.8" files = [ - {file = "regex-2024.4.28-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:cd196d056b40af073d95a2879678585f0b74ad35190fac04ca67954c582c6b61"}, - {file = "regex-2024.4.28-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:8bb381f777351bd534462f63e1c6afb10a7caa9fa2a421ae22c26e796fe31b1f"}, - {file = "regex-2024.4.28-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:47af45b6153522733aa6e92543938e97a70ce0900649ba626cf5aad290b737b6"}, - {file = "regex-2024.4.28-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:99d6a550425cc51c656331af0e2b1651e90eaaa23fb4acde577cf15068e2e20f"}, - {file = "regex-2024.4.28-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:bf29304a8011feb58913c382902fde3395957a47645bf848eea695839aa101b7"}, - {file = "regex-2024.4.28-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:92da587eee39a52c91aebea8b850e4e4f095fe5928d415cb7ed656b3460ae79a"}, - {file = "regex-2024.4.28-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6277d426e2f31bdbacb377d17a7475e32b2d7d1f02faaecc48d8e370c6a3ff31"}, - {file = "regex-2024.4.28-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:28e1f28d07220c0f3da0e8fcd5a115bbb53f8b55cecf9bec0c946eb9a059a94c"}, - {file = "regex-2024.4.28-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:aaa179975a64790c1f2701ac562b5eeb733946eeb036b5bcca05c8d928a62f10"}, - {file = "regex-2024.4.28-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:6f435946b7bf7a1b438b4e6b149b947c837cb23c704e780c19ba3e6855dbbdd3"}, - {file = "regex-2024.4.28-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:19d6c11bf35a6ad077eb23852827f91c804eeb71ecb85db4ee1386825b9dc4db"}, - {file = "regex-2024.4.28-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:fdae0120cddc839eb8e3c15faa8ad541cc6d906d3eb24d82fb041cfe2807bc1e"}, - {file = "regex-2024.4.28-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:e672cf9caaf669053121f1766d659a8813bd547edef6e009205378faf45c67b8"}, - {file = "regex-2024.4.28-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:f57515750d07e14743db55d59759893fdb21d2668f39e549a7d6cad5d70f9fea"}, - {file = "regex-2024.4.28-cp310-cp310-win32.whl", hash = "sha256:a1409c4eccb6981c7baabc8888d3550df518add6e06fe74fa1d9312c1838652d"}, - {file = "regex-2024.4.28-cp310-cp310-win_amd64.whl", hash = "sha256:1f687a28640f763f23f8a9801fe9e1b37338bb1ca5d564ddd41619458f1f22d1"}, - {file = "regex-2024.4.28-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:84077821c85f222362b72fdc44f7a3a13587a013a45cf14534df1cbbdc9a6796"}, - {file = "regex-2024.4.28-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:b45d4503de8f4f3dc02f1d28a9b039e5504a02cc18906cfe744c11def942e9eb"}, - {file = "regex-2024.4.28-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:457c2cd5a646dd4ed536c92b535d73548fb8e216ebee602aa9f48e068fc393f3"}, - {file = "regex-2024.4.28-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:2b51739ddfd013c6f657b55a508de8b9ea78b56d22b236052c3a85a675102dc6"}, - {file = "regex-2024.4.28-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:459226445c7d7454981c4c0ce0ad1a72e1e751c3e417f305722bbcee6697e06a"}, - {file = "regex-2024.4.28-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:670fa596984b08a4a769491cbdf22350431970d0112e03d7e4eeaecaafcd0fec"}, - {file = "regex-2024.4.28-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:fe00f4fe11c8a521b173e6324d862ee7ee3412bf7107570c9b564fe1119b56fb"}, - {file = "regex-2024.4.28-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:36f392dc7763fe7924575475736bddf9ab9f7a66b920932d0ea50c2ded2f5636"}, - {file = "regex-2024.4.28-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:23a412b7b1a7063f81a742463f38821097b6a37ce1e5b89dd8e871d14dbfd86b"}, - {file = "regex-2024.4.28-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:f1d6e4b7b2ae3a6a9df53efbf199e4bfcff0959dbdb5fd9ced34d4407348e39a"}, - {file = "regex-2024.4.28-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:499334ad139557de97cbc4347ee921c0e2b5e9c0f009859e74f3f77918339257"}, - {file = "regex-2024.4.28-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:0940038bec2fe9e26b203d636c44d31dd8766abc1fe66262da6484bd82461ccf"}, - {file = "regex-2024.4.28-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:66372c2a01782c5fe8e04bff4a2a0121a9897e19223d9eab30c54c50b2ebeb7f"}, - {file = "regex-2024.4.28-cp311-cp311-win32.whl", hash = "sha256:c77d10ec3c1cf328b2f501ca32583625987ea0f23a0c2a49b37a39ee5c4c4630"}, - {file = "regex-2024.4.28-cp311-cp311-win_amd64.whl", hash = "sha256:fc0916c4295c64d6890a46e02d4482bb5ccf33bf1a824c0eaa9e83b148291f90"}, - {file = "regex-2024.4.28-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:08a1749f04fee2811c7617fdd46d2e46d09106fa8f475c884b65c01326eb15c5"}, - {file = "regex-2024.4.28-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:b8eb28995771c087a73338f695a08c9abfdf723d185e57b97f6175c5051ff1ae"}, - {file = "regex-2024.4.28-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:dd7ef715ccb8040954d44cfeff17e6b8e9f79c8019daae2fd30a8806ef5435c0"}, - {file = "regex-2024.4.28-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:fb0315a2b26fde4005a7c401707c5352df274460f2f85b209cf6024271373013"}, - {file = "regex-2024.4.28-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:f2fc053228a6bd3a17a9b0a3f15c3ab3cf95727b00557e92e1cfe094b88cc662"}, - {file = "regex-2024.4.28-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:7fe9739a686dc44733d52d6e4f7b9c77b285e49edf8570754b322bca6b85b4cc"}, - {file = "regex-2024.4.28-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a74fcf77d979364f9b69fcf8200849ca29a374973dc193a7317698aa37d8b01c"}, - {file = "regex-2024.4.28-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:965fd0cf4694d76f6564896b422724ec7b959ef927a7cb187fc6b3f4e4f59833"}, - {file = "regex-2024.4.28-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:2fef0b38c34ae675fcbb1b5db760d40c3fc3612cfa186e9e50df5782cac02bcd"}, - {file = "regex-2024.4.28-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:bc365ce25f6c7c5ed70e4bc674f9137f52b7dd6a125037f9132a7be52b8a252f"}, - {file = "regex-2024.4.28-cp312-cp312-musllinux_1_1_ppc64le.whl", hash = "sha256:ac69b394764bb857429b031d29d9604842bc4cbfd964d764b1af1868eeebc4f0"}, - {file = "regex-2024.4.28-cp312-cp312-musllinux_1_1_s390x.whl", hash = "sha256:144a1fc54765f5c5c36d6d4b073299832aa1ec6a746a6452c3ee7b46b3d3b11d"}, - {file = "regex-2024.4.28-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:2630ca4e152c221072fd4a56d4622b5ada876f668ecd24d5ab62544ae6793ed6"}, - {file = "regex-2024.4.28-cp312-cp312-win32.whl", hash = "sha256:7f3502f03b4da52bbe8ba962621daa846f38489cae5c4a7b5d738f15f6443d17"}, - {file = "regex-2024.4.28-cp312-cp312-win_amd64.whl", hash = "sha256:0dd3f69098511e71880fb00f5815db9ed0ef62c05775395968299cb400aeab82"}, - {file = "regex-2024.4.28-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:374f690e1dd0dbdcddea4a5c9bdd97632cf656c69113f7cd6a361f2a67221cb6"}, - {file = "regex-2024.4.28-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:25f87ae6b96374db20f180eab083aafe419b194e96e4f282c40191e71980c666"}, - {file = "regex-2024.4.28-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:5dbc1bcc7413eebe5f18196e22804a3be1bfdfc7e2afd415e12c068624d48247"}, - {file = "regex-2024.4.28-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f85151ec5a232335f1be022b09fbbe459042ea1951d8a48fef251223fc67eee1"}, - {file = "regex-2024.4.28-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:57ba112e5530530fd175ed550373eb263db4ca98b5f00694d73b18b9a02e7185"}, - {file = "regex-2024.4.28-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:224803b74aab56aa7be313f92a8d9911dcade37e5f167db62a738d0c85fdac4b"}, - {file = "regex-2024.4.28-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:0a54a047b607fd2d2d52a05e6ad294602f1e0dec2291152b745870afc47c1397"}, - {file = "regex-2024.4.28-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:0a2a512d623f1f2d01d881513af9fc6a7c46e5cfffb7dc50c38ce959f9246c94"}, - {file = "regex-2024.4.28-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:c06bf3f38f0707592898428636cbb75d0a846651b053a1cf748763e3063a6925"}, - {file = "regex-2024.4.28-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:1031a5e7b048ee371ab3653aad3030ecfad6ee9ecdc85f0242c57751a05b0ac4"}, - {file = "regex-2024.4.28-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:d7a353ebfa7154c871a35caca7bfd8f9e18666829a1dc187115b80e35a29393e"}, - {file = "regex-2024.4.28-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:7e76b9cfbf5ced1aca15a0e5b6f229344d9b3123439ffce552b11faab0114a02"}, - {file = "regex-2024.4.28-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:5ce479ecc068bc2a74cb98dd8dba99e070d1b2f4a8371a7dfe631f85db70fe6e"}, - {file = "regex-2024.4.28-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:7d77b6f63f806578c604dca209280e4c54f0fa9a8128bb8d2cc5fb6f99da4150"}, - {file = "regex-2024.4.28-cp38-cp38-win32.whl", hash = "sha256:d84308f097d7a513359757c69707ad339da799e53b7393819ec2ea36bc4beb58"}, - {file = "regex-2024.4.28-cp38-cp38-win_amd64.whl", hash = "sha256:2cc1b87bba1dd1a898e664a31012725e48af826bf3971e786c53e32e02adae6c"}, - {file = "regex-2024.4.28-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:7413167c507a768eafb5424413c5b2f515c606be5bb4ef8c5dee43925aa5718b"}, - {file = "regex-2024.4.28-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:108e2dcf0b53a7c4ab8986842a8edcb8ab2e59919a74ff51c296772e8e74d0ae"}, - {file = "regex-2024.4.28-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:f1c5742c31ba7d72f2dedf7968998730664b45e38827637e0f04a2ac7de2f5f1"}, - {file = "regex-2024.4.28-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ecc6148228c9ae25ce403eade13a0961de1cb016bdb35c6eafd8e7b87ad028b1"}, - {file = "regex-2024.4.28-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:b7d893c8cf0e2429b823ef1a1d360a25950ed11f0e2a9df2b5198821832e1947"}, - {file = "regex-2024.4.28-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:4290035b169578ffbbfa50d904d26bec16a94526071ebec3dadbebf67a26b25e"}, - {file = "regex-2024.4.28-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:44a22ae1cfd82e4ffa2066eb3390777dc79468f866f0625261a93e44cdf6482b"}, - {file = "regex-2024.4.28-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:fd24fd140b69f0b0bcc9165c397e9b2e89ecbeda83303abf2a072609f60239e2"}, - {file = "regex-2024.4.28-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:39fb166d2196413bead229cd64a2ffd6ec78ebab83fff7d2701103cf9f4dfd26"}, - {file = "regex-2024.4.28-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:9301cc6db4d83d2c0719f7fcda37229691745168bf6ae849bea2e85fc769175d"}, - {file = "regex-2024.4.28-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:7c3d389e8d76a49923683123730c33e9553063d9041658f23897f0b396b2386f"}, - {file = "regex-2024.4.28-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:99ef6289b62042500d581170d06e17f5353b111a15aa6b25b05b91c6886df8fc"}, - {file = "regex-2024.4.28-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:b91d529b47798c016d4b4c1d06cc826ac40d196da54f0de3c519f5a297c5076a"}, - {file = "regex-2024.4.28-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:43548ad74ea50456e1c68d3c67fff3de64c6edb85bcd511d1136f9b5376fc9d1"}, - {file = "regex-2024.4.28-cp39-cp39-win32.whl", hash = "sha256:05d9b6578a22db7dedb4df81451f360395828b04f4513980b6bd7a1412c679cc"}, - {file = "regex-2024.4.28-cp39-cp39-win_amd64.whl", hash = "sha256:3986217ec830c2109875be740531feb8ddafe0dfa49767cdcd072ed7e8927962"}, - {file = "regex-2024.4.28.tar.gz", hash = "sha256:83ab366777ea45d58f72593adf35d36ca911ea8bd838483c1823b883a121b0e4"}, + {file = "regex-2024.5.10-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:eda3dd46df535da787ffb9036b5140f941ecb91701717df91c9daf64cabef953"}, + {file = "regex-2024.5.10-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:1d5bd666466c8f00a06886ce1397ba8b12371c1f1c6d1bef11013e9e0a1464a8"}, + {file = "regex-2024.5.10-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:32e5f3b8e32918bfbdd12eca62e49ab3031125c454b507127ad6ecbd86e62fca"}, + {file = "regex-2024.5.10-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:534efd2653ebc4f26fc0e47234e53bf0cb4715bb61f98c64d2774a278b58c846"}, + {file = "regex-2024.5.10-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:193b7c6834a06f722f0ce1ba685efe80881de7c3de31415513862f601097648c"}, + {file = "regex-2024.5.10-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:160ba087232c5c6e2a1e7ad08bd3a3f49b58c815be0504d8c8aacfb064491cd8"}, + {file = "regex-2024.5.10-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:951be1eae7b47660412dc4938777a975ebc41936d64e28081bf2e584b47ec246"}, + {file = "regex-2024.5.10-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:d8a0f0ab5453e409586b11ebe91c672040bc804ca98d03a656825f7890cbdf88"}, + {file = "regex-2024.5.10-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:9e6d4d6ae1827b2f8c7200aaf7501c37cf3f3896c86a6aaf2566448397c823dd"}, + {file = "regex-2024.5.10-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:161a206c8f3511e2f5fafc9142a2cc25d7fe9a1ec5ad9b4ad2496a7c33e1c5d2"}, + {file = "regex-2024.5.10-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:44b3267cea873684af022822195298501568ed44d542f9a2d9bebc0212e99069"}, + {file = "regex-2024.5.10-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:560278c9975694e1f0bc50da187abf2cdc1e4890739ea33df2bc4a85eeef143e"}, + {file = "regex-2024.5.10-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:70364a097437dd0a90b31cd77f09f7387ad9ac60ef57590971f43b7fca3082a5"}, + {file = "regex-2024.5.10-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:42be5de7cc8c1edac55db92d82b68dc8e683b204d6f5414c5a51997a323d7081"}, + {file = "regex-2024.5.10-cp310-cp310-win32.whl", hash = "sha256:9a8625849387b9d558d528e263ecc9c0fbde86cfa5c2f0eef43fff480ae24d71"}, + {file = "regex-2024.5.10-cp310-cp310-win_amd64.whl", hash = "sha256:903350bf44d7e4116b4d5898b30b15755d61dcd3161e3413a49c7db76f0bee5a"}, + {file = "regex-2024.5.10-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:bf9596cba92ce7b1fd32c7b07c6e3212c7eed0edc271757e48bfcd2b54646452"}, + {file = "regex-2024.5.10-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:45cc13d398b6359a7708986386f72bd156ae781c3e83a68a6d4cee5af04b1ce9"}, + {file = "regex-2024.5.10-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:ad45f3bccfcb00868f2871dce02a755529838d2b86163ab8a246115e80cfb7d6"}, + {file = "regex-2024.5.10-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:33d19f0cde6838c81acffff25c7708e4adc7dd02896c9ec25c3939b1500a1778"}, + {file = "regex-2024.5.10-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:0a9f89d7db5ef6bdf53e5cc8e6199a493d0f1374b3171796b464a74ebe8e508a"}, + {file = "regex-2024.5.10-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:8c6c71cf92b09e5faa72ea2c68aa1f61c9ce11cb66fdc5069d712f4392ddfd00"}, + {file = "regex-2024.5.10-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7467ad8b0eac0b28e52679e972b9b234b3de0ea5cee12eb50091d2b68145fe36"}, + {file = "regex-2024.5.10-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:bc0db93ad039fc2fe32ccd3dd0e0e70c4f3d6e37ae83f0a487e1aba939bd2fbd"}, + {file = "regex-2024.5.10-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:fa9335674d7c819674467c7b46154196c51efbaf5f5715187fd366814ba3fa39"}, + {file = "regex-2024.5.10-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:7dda3091838206969c2b286f9832dff41e2da545b99d1cfaea9ebd8584d02708"}, + {file = "regex-2024.5.10-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:504b5116e2bd1821efd815941edff7535e93372a098e156bb9dffde30264e798"}, + {file = "regex-2024.5.10-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:91b53dea84415e8115506cc62e441a2b54537359c63d856d73cb1abe05af4c9a"}, + {file = "regex-2024.5.10-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:1a3903128f9e17a500618e80c68165c78c741ebb17dd1a0b44575f92c3c68b02"}, + {file = "regex-2024.5.10-cp311-cp311-win32.whl", hash = "sha256:236cace6c1903effd647ed46ce6dd5d76d54985fc36dafc5256032886736c85d"}, + {file = "regex-2024.5.10-cp311-cp311-win_amd64.whl", hash = "sha256:12446827f43c7881decf2c126762e11425de5eb93b3b0d8b581344c16db7047a"}, + {file = "regex-2024.5.10-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:14905ed75c7a6edf423eb46c213ed3f4507c38115f1ed3c00f4ec9eafba50e58"}, + {file = "regex-2024.5.10-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:4fad420b14ae1970a1f322e8ae84a1d9d89375eb71e1b504060ab2d1bfe68f3c"}, + {file = "regex-2024.5.10-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:c46a76a599fcbf95f98755275c5527304cc4f1bb69919434c1e15544d7052910"}, + {file = "regex-2024.5.10-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0faecb6d5779753a6066a3c7a0471a8d29fe25d9981ca9e552d6d1b8f8b6a594"}, + {file = "regex-2024.5.10-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:aab65121229c2ecdf4a31b793d99a6a0501225bd39b616e653c87b219ed34a49"}, + {file = "regex-2024.5.10-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:50e7e96a527488334379e05755b210b7da4a60fc5d6481938c1fa053e0c92184"}, + {file = "regex-2024.5.10-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ba034c8db4b264ef1601eb33cd23d87c5013b8fb48b8161debe2e5d3bd9156b0"}, + {file = "regex-2024.5.10-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:031219782d97550c2098d9a68ce9e9eaefe67d2d81d8ff84c8354f9c009e720c"}, + {file = "regex-2024.5.10-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:62b5f7910b639f3c1d122d408421317c351e213ca39c964ad4121f27916631c6"}, + {file = "regex-2024.5.10-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:cd832bd9b6120d6074f39bdfbb3c80e416848b07ac72910f1c7f03131a6debc3"}, + {file = "regex-2024.5.10-cp312-cp312-musllinux_1_1_ppc64le.whl", hash = "sha256:e91b1976358e17197157b405cab408a5f4e33310cda211c49fc6da7cffd0b2f0"}, + {file = "regex-2024.5.10-cp312-cp312-musllinux_1_1_s390x.whl", hash = "sha256:571452362d552de508c37191b6abbbb660028b8b418e2d68c20779e0bc8eaaa8"}, + {file = "regex-2024.5.10-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:5253dcb0bfda7214523de58b002eb0090cb530d7c55993ce5f6d17faf953ece7"}, + {file = "regex-2024.5.10-cp312-cp312-win32.whl", hash = "sha256:2f30a5ab8902f93930dc6f627c4dd5da2703333287081c85cace0fc6e21c25af"}, + {file = "regex-2024.5.10-cp312-cp312-win_amd64.whl", hash = "sha256:3799e36d60a35162bb35b2246d8bb012192b7437dff807ef79c14e7352706306"}, + {file = "regex-2024.5.10-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:bbdc5db2c98ac2bf1971ffa1410c87ca7a15800415f788971e8ba8520fc0fda9"}, + {file = "regex-2024.5.10-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:6ccdeef4584450b6f0bddd5135354908dacad95425fcb629fe36d13e48b60f32"}, + {file = "regex-2024.5.10-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:29d839829209f3c53f004e1de8c3113efce6d98029f044fa5cfee666253ee7e6"}, + {file = "regex-2024.5.10-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0709ba544cf50bd5cb843df4b8bb6701bae2b70a8e88da9add8386cbca5c1385"}, + {file = "regex-2024.5.10-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:972b49f2fe1047b9249c958ec4fa1bdd2cf8ce305dc19d27546d5a38e57732d8"}, + {file = "regex-2024.5.10-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:9cdbb1998da94607d5eec02566b9586f0e70d6438abf1b690261aac0edda7ab6"}, + {file = "regex-2024.5.10-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bf7c8ee4861d9ef5b1120abb75846828c811f932d63311596ad25fa168053e00"}, + {file = "regex-2024.5.10-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:7d35d4cc9270944e95f9c88af757b0c9fc43f396917e143a5756608462c5223b"}, + {file = "regex-2024.5.10-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:8722f72068b3e1156a4b2e1afde6810f1fc67155a9fa30a4b9d5b4bc46f18fb0"}, + {file = "regex-2024.5.10-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:696639a73ca78a380acfaa0a1f6dd8220616a99074c05bba9ba8bb916914b224"}, + {file = "regex-2024.5.10-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:ea057306ab469130167014b662643cfaed84651c792948891d003cf0039223a5"}, + {file = "regex-2024.5.10-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:b43b78f9386d3d932a6ce5af4b45f393d2e93693ee18dc4800d30a8909df700e"}, + {file = "regex-2024.5.10-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:c43395a3b7cc9862801a65c6994678484f186ce13c929abab44fb8a9e473a55a"}, + {file = "regex-2024.5.10-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:0bc94873ba11e34837bffd7e5006703abeffc4514e2f482022f46ce05bd25e67"}, + {file = "regex-2024.5.10-cp38-cp38-win32.whl", hash = "sha256:1118ba9def608250250f4b3e3f48c62f4562ba16ca58ede491b6e7554bfa09ff"}, + {file = "regex-2024.5.10-cp38-cp38-win_amd64.whl", hash = "sha256:458d68d34fb74b906709735c927c029e62f7d06437a98af1b5b6258025223210"}, + {file = "regex-2024.5.10-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:15e593386ec6331e0ab4ac0795b7593f02ab2f4b30a698beb89fbdc34f92386a"}, + {file = "regex-2024.5.10-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:ca23b41355ba95929e9505ee04e55495726aa2282003ed9b012d86f857d3e49b"}, + {file = "regex-2024.5.10-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:2c8982ee19ccecabbaeac1ba687bfef085a6352a8c64f821ce2f43e6d76a9298"}, + {file = "regex-2024.5.10-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:7117cb7d6ac7f2e985f3d18aa8a1728864097da1a677ffa69e970ca215baebf1"}, + {file = "regex-2024.5.10-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:b66421f8878a0c82fc0c272a43e2121c8d4c67cb37429b764f0d5ad70b82993b"}, + {file = "regex-2024.5.10-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:224a9269f133564109ce668213ef3cb32bc72ccf040b0b51c72a50e569e9dc9e"}, + {file = "regex-2024.5.10-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ab98016541543692a37905871a5ffca59b16e08aacc3d7d10a27297b443f572d"}, + {file = "regex-2024.5.10-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:51d27844763c273a122e08a3e86e7aefa54ee09fb672d96a645ece0454d8425e"}, + {file = "regex-2024.5.10-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:853cc36e756ff673bf984e9044ccc8fad60b95a748915dddeab9488aea974c73"}, + {file = "regex-2024.5.10-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:4e7eaf9df15423d07b6050fb91f86c66307171b95ea53e2d87a7993b6d02c7f7"}, + {file = "regex-2024.5.10-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:169fd0acd7a259f58f417e492e93d0e15fc87592cd1e971c8c533ad5703b5830"}, + {file = "regex-2024.5.10-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:334b79ce9c08f26b4659a53f42892793948a613c46f1b583e985fd5a6bf1c149"}, + {file = "regex-2024.5.10-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:f03b1dbd4d9596dd84955bb40f7d885204d6aac0d56a919bb1e0ff2fb7e1735a"}, + {file = "regex-2024.5.10-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:cfa6d61a76c77610ba9274c1a90a453062bdf6887858afbe214d18ad41cf6bde"}, + {file = "regex-2024.5.10-cp39-cp39-win32.whl", hash = "sha256:249fbcee0a277c32a3ce36d8e36d50c27c968fdf969e0fbe342658d4e010fbc8"}, + {file = "regex-2024.5.10-cp39-cp39-win_amd64.whl", hash = "sha256:0ce56a923f4c01d7568811bfdffe156268c0a7aae8a94c902b92fe34c4bde785"}, + {file = "regex-2024.5.10.tar.gz", hash = "sha256:304e7e2418146ae4d0ef0e9ffa28f881f7874b45b4994cc2279b21b6e7ae50c8"}, ] [[package]] @@ -1640,28 +1639,28 @@ use-chardet-on-py3 = ["chardet (>=3.0.2,<6)"] [[package]] name = "ruff" -version = "0.4.3" +version = "0.4.4" description = "An extremely fast Python linter and code formatter, written in Rust." optional = false python-versions = ">=3.7" files = [ - {file = "ruff-0.4.3-py3-none-macosx_10_12_x86_64.whl", hash = "sha256:b70800c290f14ae6fcbb41bbe201cf62dfca024d124a1f373e76371a007454ce"}, - {file = "ruff-0.4.3-py3-none-macosx_11_0_arm64.whl", hash = "sha256:08a0d6a22918ab2552ace96adeaca308833873a4d7d1d587bb1d37bae8728eb3"}, - {file = "ruff-0.4.3-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:eba1f14df3c758dd7de5b55fbae7e1c8af238597961e5fb628f3de446c3c40c5"}, - {file = "ruff-0.4.3-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:819fb06d535cc76dfddbfe8d3068ff602ddeb40e3eacbc90e0d1272bb8d97113"}, - {file = "ruff-0.4.3-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:0bfc9e955e6dc6359eb6f82ea150c4f4e82b660e5b58d9a20a0e42ec3bb6342b"}, - {file = "ruff-0.4.3-py3-none-manylinux_2_17_ppc64.manylinux2014_ppc64.whl", hash = "sha256:510a67d232d2ebe983fddea324dbf9d69b71c4d2dfeb8a862f4a127536dd4cfb"}, - {file = "ruff-0.4.3-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:dc9ff11cd9a092ee7680a56d21f302bdda14327772cd870d806610a3503d001f"}, - {file = "ruff-0.4.3-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:29efff25bf9ee685c2c8390563a5b5c006a3fee5230d28ea39f4f75f9d0b6f2f"}, - {file = "ruff-0.4.3-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:18b00e0bcccf0fc8d7186ed21e311dffd19761cb632241a6e4fe4477cc80ef6e"}, - {file = "ruff-0.4.3-py3-none-musllinux_1_2_aarch64.whl", hash = "sha256:262f5635e2c74d80b7507fbc2fac28fe0d4fef26373bbc62039526f7722bca1b"}, - {file = "ruff-0.4.3-py3-none-musllinux_1_2_armv7l.whl", hash = "sha256:7363691198719c26459e08cc17c6a3dac6f592e9ea3d2fa772f4e561b5fe82a3"}, - {file = "ruff-0.4.3-py3-none-musllinux_1_2_i686.whl", hash = "sha256:eeb039f8428fcb6725bb63cbae92ad67b0559e68b5d80f840f11914afd8ddf7f"}, - {file = "ruff-0.4.3-py3-none-musllinux_1_2_x86_64.whl", hash = "sha256:927b11c1e4d0727ce1a729eace61cee88a334623ec424c0b1c8fe3e5f9d3c865"}, - {file = "ruff-0.4.3-py3-none-win32.whl", hash = "sha256:25cacda2155778beb0d064e0ec5a3944dcca9c12715f7c4634fd9d93ac33fd30"}, - {file = "ruff-0.4.3-py3-none-win_amd64.whl", hash = "sha256:7a1c3a450bc6539ef00da6c819fb1b76b6b065dec585f91456e7c0d6a0bbc725"}, - {file = "ruff-0.4.3-py3-none-win_arm64.whl", hash = "sha256:71ca5f8ccf1121b95a59649482470c5601c60a416bf189d553955b0338e34614"}, - {file = "ruff-0.4.3.tar.gz", hash = "sha256:ff0a3ef2e3c4b6d133fbedcf9586abfbe38d076041f2dc18ffb2c7e0485d5a07"}, + {file = "ruff-0.4.4-py3-none-macosx_10_12_x86_64.whl", hash = "sha256:29d44ef5bb6a08e235c8249294fa8d431adc1426bfda99ed493119e6f9ea1bf6"}, + {file = "ruff-0.4.4-py3-none-macosx_11_0_arm64.whl", hash = "sha256:c4efe62b5bbb24178c950732ddd40712b878a9b96b1d02b0ff0b08a090cbd891"}, + {file = "ruff-0.4.4-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4c8e2f1e8fc12d07ab521a9005d68a969e167b589cbcaee354cb61e9d9de9c15"}, + {file = "ruff-0.4.4-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:60ed88b636a463214905c002fa3eaab19795679ed55529f91e488db3fe8976ab"}, + {file = "ruff-0.4.4-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:b90fc5e170fc71c712cc4d9ab0e24ea505c6a9e4ebf346787a67e691dfb72e85"}, + {file = "ruff-0.4.4-py3-none-manylinux_2_17_ppc64.manylinux2014_ppc64.whl", hash = "sha256:8e7e6ebc10ef16dcdc77fd5557ee60647512b400e4a60bdc4849468f076f6eef"}, + {file = "ruff-0.4.4-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:b9ddb2c494fb79fc208cd15ffe08f32b7682519e067413dbaf5f4b01a6087bcd"}, + {file = "ruff-0.4.4-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:c51c928a14f9f0a871082603e25a1588059b7e08a920f2f9fa7157b5bf08cfe9"}, + {file = "ruff-0.4.4-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b5eb0a4bfd6400b7d07c09a7725e1a98c3b838be557fee229ac0f84d9aa49c36"}, + {file = "ruff-0.4.4-py3-none-musllinux_1_2_aarch64.whl", hash = "sha256:b1867ee9bf3acc21778dcb293db504692eda5f7a11a6e6cc40890182a9f9e595"}, + {file = "ruff-0.4.4-py3-none-musllinux_1_2_armv7l.whl", hash = "sha256:1aecced1269481ef2894cc495647392a34b0bf3e28ff53ed95a385b13aa45768"}, + {file = "ruff-0.4.4-py3-none-musllinux_1_2_i686.whl", hash = "sha256:9da73eb616b3241a307b837f32756dc20a0b07e2bcb694fec73699c93d04a69e"}, + {file = "ruff-0.4.4-py3-none-musllinux_1_2_x86_64.whl", hash = "sha256:958b4ea5589706a81065e2a776237de2ecc3e763342e5cc8e02a4a4d8a5e6f95"}, + {file = "ruff-0.4.4-py3-none-win32.whl", hash = "sha256:cb53473849f011bca6e754f2cdf47cafc9c4f4ff4570003a0dad0b9b6890e876"}, + {file = "ruff-0.4.4-py3-none-win_amd64.whl", hash = "sha256:424e5b72597482543b684c11def82669cc6b395aa8cc69acc1858b5ef3e5daae"}, + {file = "ruff-0.4.4-py3-none-win_arm64.whl", hash = "sha256:39df0537b47d3b597293edbb95baf54ff5b49589eb7ff41926d8243caa995ea6"}, + {file = "ruff-0.4.4.tar.gz", hash = "sha256:f87ea42d5cdebdc6a69761a9d0bc83ae9b3b30d0ad78952005ba6568d6c022af"}, ] [[package]] @@ -2045,4 +2044,4 @@ files = [ [metadata] lock-version = "2.0" python-versions = "^3.10" -content-hash = "c63a43bc4e1100208b7076ad0ff994f166fbdfe7b26a4b42f3e12837a747efe2" +content-hash = "ce9d0487b988e1e29c0315a61ead17dde006cf19370ed1a3eec459b9a1ad5c49" diff --git a/pyproject.toml b/pyproject.toml index 8e90c7e..1c66001 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,22 +1,22 @@ [tool.poetry] -name = "{{project_name}}" +name = "cookie-doh" version = "0.0.0" description = "" authors = ["microsoft"] license = "MIT License" readme = "README.md" -packages = [{ include = "{{module_name}}", from = "src/python" }] +packages = [{ include = "cookie", from = "src" }] [tool.poetry.dependencies] # write here dependencies of your project python = "^3.10" [tool.poetry.group.dev.dependencies] -coverage = "^7.5.1" -ipykernel = "^6.29.2" -ruff = "^0.4.3" -pyright = "^1.1.349" -pytest = "^8.0.0" +coverage = "*" +ipykernel = "*" +ruff = "*" +pyright = "*" +pytest = "*" [tool.poetry.group.docs.dependencies] mdx-truly-sane-lists = "*" @@ -24,7 +24,7 @@ mkdocs = "*" mkdocs-awesome-pages-plugin = "*" mkdocs-material = "*" mkdocs-video = "*" -pymdown-extensions = ">=10.0.0" # Fix CVE-2023-32309 pymdown-extensions 9.10 +pymdown-extensions = "*" sphinx = "*" sphinx-autodoc-typehints = "*" sphinx-markdown-builder = "*" diff --git a/pyproject.toml.jinja b/pyproject.toml.jinja deleted file mode 120000 index 7b2511e..0000000 --- a/pyproject.toml.jinja +++ /dev/null @@ -1 +0,0 @@ -pyproject.toml \ No newline at end of file diff --git a/pyrightconfig.json b/pyrightconfig.json index f3639d5..17c2e34 100644 --- a/pyrightconfig.json +++ b/pyrightconfig.json @@ -1,8 +1,8 @@ { "pythonVersion": "3.10", "include": [ - "src/python", - "test/python" + "src", + "test" ], "exclude": [ "**/__pycache__" diff --git a/ruff.toml b/ruff.toml index af84024..ce651df 100644 --- a/ruff.toml +++ b/ruff.toml @@ -1,5 +1,5 @@ cache-dir = ".tmp/.ruff_cache" -include = ["src/python/**/*.py", "test/python/**/*.py"] +include = ["src/**/*.py", "test/**/*.py"] line-length = 99 indent-width = 4 target-version = "py310" diff --git a/ruff.toml.jinja b/ruff.toml.jinja deleted file mode 120000 index 4acdc43..0000000 --- a/ruff.toml.jinja +++ /dev/null @@ -1 +0,0 @@ -ruff.toml \ No newline at end of file diff --git a/src/python/{{module_name}}/__init__.py b/src/cookie/__init__.py similarity index 100% rename from src/python/{{module_name}}/__init__.py rename to src/cookie/__init__.py diff --git a/src/python/{{module_name}}/example.py b/src/cookie/example.py similarity index 100% rename from src/python/{{module_name}}/example.py rename to src/cookie/example.py diff --git a/template/.codespellrc b/template/.codespellrc new file mode 120000 index 0000000..e6ae24f --- /dev/null +++ b/template/.codespellrc @@ -0,0 +1 @@ +../.codespellrc \ No newline at end of file diff --git a/.copier-answers.yml.jinja b/template/.copier-answers.yml.jinja similarity index 100% rename from .copier-answers.yml.jinja rename to template/.copier-answers.yml.jinja diff --git a/template/.coveragerc b/template/.coveragerc new file mode 120000 index 0000000..5078514 --- /dev/null +++ b/template/.coveragerc @@ -0,0 +1 @@ +../.coveragerc \ No newline at end of file diff --git a/template/.devcontainer b/template/.devcontainer new file mode 120000 index 0000000..485dcb2 --- /dev/null +++ b/template/.devcontainer @@ -0,0 +1 @@ +../.devcontainer \ No newline at end of file diff --git a/template/.editorconfig b/template/.editorconfig new file mode 120000 index 0000000..38d9a0c --- /dev/null +++ b/template/.editorconfig @@ -0,0 +1 @@ +../.editorconfig \ No newline at end of file diff --git a/template/.envrc.jinja b/template/.envrc.jinja new file mode 120000 index 0000000..8d83695 --- /dev/null +++ b/template/.envrc.jinja @@ -0,0 +1 @@ +../.envrc \ No newline at end of file diff --git a/template/.github/dependabot.yaml b/template/.github/dependabot.yaml new file mode 120000 index 0000000..75ec997 --- /dev/null +++ b/template/.github/dependabot.yaml @@ -0,0 +1 @@ +../../.github/dependabot.yaml \ No newline at end of file diff --git a/template/.github/workflows/codeql.yml b/template/.github/workflows/codeql.yml new file mode 120000 index 0000000..fad4917 --- /dev/null +++ b/template/.github/workflows/codeql.yml @@ -0,0 +1 @@ +../../../.github/workflows/codeql.yml \ No newline at end of file diff --git a/template/.github/workflows/main.yml.jinja b/template/.github/workflows/main.yml.jinja new file mode 100644 index 0000000..a64d8a2 --- /dev/null +++ b/template/.github/workflows/main.yml.jinja @@ -0,0 +1,36 @@ +name: main + +on: + workflow_dispatch: + push: + branches: [ main ] + tags: + - "v[0-9]+.[0-9]+.[0-9]+" + +concurrency: + group: {% raw %}${{ github.workflow }}-${{ github.ref }}{% endraw %} + cancel-in-progress: true + +jobs: +{%- if precommit %} + pre-commit: + uses: ./.github/workflows/pre-commit.yml +{% endif %} + run-tests: + uses: ./.github/workflows/run-tests.yml +{% if documentation %} + build-docs: + uses: ./.github/workflows/build-docs.yml + secrets: inherit + permissions: + contents: read + pages: write + id-token: write +{% endif %} + codeql: + uses: ./.github/workflows/codeql.yml + secrets: inherit + permissions: + contents: read + actions: read + security-events: write diff --git a/template/.github/workflows/pr.yml.jinja b/template/.github/workflows/pr.yml.jinja new file mode 100644 index 0000000..08c67f1 --- /dev/null +++ b/template/.github/workflows/pr.yml.jinja @@ -0,0 +1,28 @@ +name: pr + +on: + pull_request: + branches: [ main ] + +concurrency: + group: {% raw %}${{ github.workflow }}-${{ github.ref }}{% endraw %} + cancel-in-progress: true + +jobs: +{%- if precommit %} + pre-commit: + uses: ./.github/workflows/pre-commit.yml +{% endif %} + run-tests: + uses: ./.github/workflows/run-tests.yml +{% if documentation %} + build-docs: + uses: ./.github/workflows/build-docs.yml +{% endif %} + codeql: + uses: ./.github/workflows/codeql.yml + secrets: inherit + permissions: + contents: read + actions: read + security-events: write diff --git a/template/.github/workflows/run-tests.yml b/template/.github/workflows/run-tests.yml new file mode 120000 index 0000000..55466b3 --- /dev/null +++ b/template/.github/workflows/run-tests.yml @@ -0,0 +1 @@ +../../../.github/workflows/run-tests.yml \ No newline at end of file diff --git a/template/.github/workflows/weekly.yml b/template/.github/workflows/weekly.yml new file mode 120000 index 0000000..0435e3b --- /dev/null +++ b/template/.github/workflows/weekly.yml @@ -0,0 +1 @@ +../../../.github/workflows/weekly.yml \ No newline at end of file diff --git a/template/.github/workflows/{% if documentation %}build-docs.yml{% endif %} b/template/.github/workflows/{% if documentation %}build-docs.yml{% endif %} new file mode 120000 index 0000000..cbcf312 --- /dev/null +++ b/template/.github/workflows/{% if documentation %}build-docs.yml{% endif %} @@ -0,0 +1 @@ +../../../.github/workflows/build-docs.yml \ No newline at end of file diff --git a/template/.github/workflows/{% if precommit %}pre-commit.yml{% endif %} b/template/.github/workflows/{% if precommit %}pre-commit.yml{% endif %} new file mode 120000 index 0000000..94e2297 --- /dev/null +++ b/template/.github/workflows/{% if precommit %}pre-commit.yml{% endif %} @@ -0,0 +1 @@ +../../../.github/workflows/pre-commit.yml \ No newline at end of file diff --git a/template/.gitignore.jinja b/template/.gitignore.jinja new file mode 100644 index 0000000..9391a48 --- /dev/null +++ b/template/.gitignore.jinja @@ -0,0 +1,36 @@ +.venv +.coverage +.tmp + +**/*.pyc +**/*.egg-info +**/build/ +.DS_Store + +# ignore the distribution and docs/api folders +**/dist +**/docs/api + +# ignore personal vscode workspace files +**/*.code-workspace +!{{project_name}}.code-workspace + +**/.vscode/* +!**/.vscode/launch.json +!**/.vscode/settings.json + +**/.idea/* +# The module files tell Pycharm about the various components in the repo. +!**/.idea/*.iml +!**/.idea/modules.xml +# Allows us to share configurations for running pytest and other tools through the IDE. +!**/.idea/runConfigurations +# Watcher tasks allow us to share things like auto formatters. +!**/.idea/watcherTasks.xml + +# Draw.io tmp files +**/*.drawio.dtmp +**/*.drawio.bkp + +# outputs +**/outputs diff --git a/template/.vscode b/template/.vscode new file mode 120000 index 0000000..1814466 --- /dev/null +++ b/template/.vscode @@ -0,0 +1 @@ +../.vscode \ No newline at end of file diff --git a/template/LICENSE.jinja b/template/LICENSE.jinja new file mode 100644 index 0000000..c58b2f6 --- /dev/null +++ b/template/LICENSE.jinja @@ -0,0 +1,21 @@ + MIT License + + Copyright (c) {{license}}. + + Permission is hereby granted, free of charge, to any person obtaining a copy + of this software and associated documentation files (the "Software"), to deal + in the Software without restriction, including without limitation the rights + to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all + copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + SOFTWARE diff --git a/template/README.md.jinja b/template/README.md.jinja new file mode 100644 index 0000000..f103a2f --- /dev/null +++ b/template/README.md.jinja @@ -0,0 +1,109 @@ +# :sparkles: {{ project_name }} + +[![main](https://github.com/{{ organization }}/{{ project_name }}/actions/workflows/main.yml/badge.svg)](https://github.com/{{ organization }}/{{ project_name }}/actions/workflows/main.yml) +[![Checked with pyright](https://{{ organization }}.github.io/pyright/img/pyright_badge.svg)](https://{{ organization }}.github.io/pyright/) +[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) + +----------------------------------------------------------------- + +{{ project_name }} info + +{% if documentation -%} +## :notebook_with_decorative_cover: Documentation +https://{{ organization }}.github.io/{{ project_name }} +{%- endif -%} + + +### Optional system dependencies + +We use the following optional dependencies for development: + +* [direnv](https://direnv.net/): To manage environment variables and load python virtual environments automatically. +* [pyenv](https://github.com/pyenv/pyenv): To manage python versions. +* [pipx](https://pipxproject.github.io/pipx/): To install python packages in isolated environments. +* [commitizen](https://commitizen-tools.github.io/commitizen/): To help with [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/). +* [cz-conventional-gitmoji](https://github.com/ljnsn/cz-conventional-gitmoji): A commitizen plugin that combines gitmoji and conventional commits. +* [pre-commit](https://pre-commit.com/): To run code formatting and linting before committing. + +### Required system dependencies + +* [poetry](https://python-poetry.org/): To manage package dependencies and virtual environments. +* [python >= 3.10](https://www.python.org/) + +For setting up the development environment: + +* Clone the repository and cd into it. +* Install the dependencies with poetry: +```bash +poetry install +``` + +### Devcontainer + +Learn about [Devcontainers](https://containers.dev/). +Requires [Docker](https://www.docker.com/get-started/) installed on your local machine. + +:point_right: Follow instructions for [VSCode](https://code.visualstudio.com/docs/devcontainers/tutorial) +and/or [PyCharm](https://www.jetbrains.com/help/pycharm/connect-to-devcontainer.html). + + +### Codespaces + +Learn about [GitHub Codespaces](https://docs.github.com/en/codespaces) and/or [DevPod](https://devpod.sh/). + +[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/{{ organization }}/{{ project_name }}) + +[![Open in DevPod!](https://devpod.sh/assets/open-in-devpod.svg)](https://devpod.sh/open#https://github.com/{{ organization }}/{{ project_name }}) + + + + +{% if organization == 'microsoft' %} +-------------------------------------------- + +## :mountain: Contributing + +This project welcomes contributions and suggestions. Most contributions require you to agree to a +Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us +the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com. + +When you submit a pull request, a CLA bot will automatically determine whether you need to provide +a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions +provided by the bot. You will only need to do this once across all repos using our CLA. + +This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). +For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or +contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. + + +## :balance_scale: Trademarks + +This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft +trademarks or logos is subject to and must follow +[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general). +Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. +Any use of third-party trademarks or logos are subject to those third-party's policies. +{% endif %} + + +{% if organization != 'microsoft' and microsoft_internal %} +## :memo: Guide to using GitHub inside {{ organization }} + +You can find information on using GitHub inside {{ organization }} at [aka.ms/gim](https://aka.ms/gim). + +
+ Expand for links to common tasks + +- [Switching between EMU GitHub and normal GitHub without logging out and back in constantly](https://aka.ms/StartRight/README-Template/maintainingMultipleAccount) +- [Creating a repository](https://aka.ms/StartRight) +- [Changing repository visibility](https://aka.ms/StartRight/README-Template/policies/jit) +- [Gaining repository permissions, access, and roles](https://aka.ms/StartRight/README-TEmplates/gim/policies/access) +- [Enabling easy access to your low sensitivity and widely applicable repository by setting it to Internal Visibility and having any FTE who wants to see it join the 1ES Enterprise Visibility MyAccess Group](https://aka.ms/StartRight/README-Template/gim/innersource-access) +- [Migrating repositories](https://aka.ms/StartRight/README-Template/troubleshoot/migration) +- [Setting branch protection](https://aka.ms/StartRight/README-Template/gim/policies/branch-protection) +- [Setting up GitHubActions](https://aka.ms/StartRight/README-Template/policies/actions) +- [and other actions](https://aka.ms/StartRight/README-Template/gim/policies) + +
+{% endif %} diff --git a/template/SUPPORT.md.jinja b/template/SUPPORT.md.jinja new file mode 100644 index 0000000..3e0e5f9 --- /dev/null +++ b/template/SUPPORT.md.jinja @@ -0,0 +1,15 @@ +# Support + +## How to file issues and get help + +This project uses GitHub Issues to track bugs and feature requests. Please search the existing +issues before filing new issues to avoid duplicates. For new issues, file your bug or +feature request as a new Issue. + +For help and questions about using this project, please use the "Discussions" tab in the repository. + +{% if organization == 'microsoft' -%} +## Microsoft Support Policy +{%- endif %} + +Support for this **PROJECT or PRODUCT** is limited to the resources listed above. diff --git a/template/bin/check-all.jinja b/template/bin/check-all.jinja new file mode 100755 index 0000000..0530ce5 --- /dev/null +++ b/template/bin/check-all.jinja @@ -0,0 +1,25 @@ +#!/usr/bin/env bash +{% if precommit %} +echo "RUNNING PRE-COMMIT HOOKS" +pre-commit run --all +{% endif %} +echo +echo "RUNNING RUFF CHECK" +poetry run ruff check + +echo +echo "RUNNING RUFF FORMAT" +poetry run ruff format + +echo +echo "RUNNING PYRIGHT" +poetry run pyright + +echo +echo "RUNNING PYTEST AND COVERAGE" +poetry run coverage run -m pytest +{% if documentation %} +echo +echo "BUILDING API AND MARKDOWN DOCS" +build-docs +{% endif -%} diff --git a/template/bin/{% if documentation %}build-docs{% endif %}.jinja b/template/bin/{% if documentation %}build-docs{% endif %}.jinja new file mode 120000 index 0000000..d0b5a8e --- /dev/null +++ b/template/bin/{% if documentation %}build-docs{% endif %}.jinja @@ -0,0 +1 @@ +../../bin/build-docs \ No newline at end of file diff --git a/template/bin/{% if documentation %}docs-api{% endif %}.jinja b/template/bin/{% if documentation %}docs-api{% endif %}.jinja new file mode 100755 index 0000000..fd45796 --- /dev/null +++ b/template/bin/{% if documentation %}docs-api{% endif %}.jinja @@ -0,0 +1,11 @@ +#!/usr/bin/env bash +set -e + +rm -rf dist/sphinx-apidoc +mkdir -p dist/sphinx-apidoc +cp .apidoc_conf.py dist/sphinx-apidoc/conf.py +poetry run sphinx-apidoc --doc-project="{{project_name}}" --tocfile=index --implicit-namespaces --module-first --output-dir=dist/sphinx-apidoc --templatedir=dist/sphinx-apidoc-templates "src/{{module_name}}" + +rm -rf dist/sphinx-markdown docs/api +poetry run sphinx-build -M markdown dist/sphinx-apidoc dist/sphinx-markdown +cp -r dist/sphinx-markdown/markdown docs/api diff --git a/template/bin/{% if documentation %}serve-docs{% endif %}.jinja b/template/bin/{% if documentation %}serve-docs{% endif %}.jinja new file mode 120000 index 0000000..284284b --- /dev/null +++ b/template/bin/{% if documentation %}serve-docs{% endif %}.jinja @@ -0,0 +1 @@ +../../bin/serve-docs \ No newline at end of file diff --git a/template/poetry.toml b/template/poetry.toml new file mode 120000 index 0000000..63315e4 --- /dev/null +++ b/template/poetry.toml @@ -0,0 +1 @@ +../poetry.toml \ No newline at end of file diff --git a/template/pyproject.toml.jinja b/template/pyproject.toml.jinja new file mode 100644 index 0000000..f5f5d8e --- /dev/null +++ b/template/pyproject.toml.jinja @@ -0,0 +1,34 @@ +[tool.poetry] +name = "{{project_name}}" +version = "0.0.0" +description = "" +authors = [] +license = "MIT License" +readme = "README.md" +packages = [{ include = "{{module_name}}", from = "src" }] + +[tool.poetry.dependencies] +# write here dependencies of your project +python = "^3.10" + +[tool.poetry.group.dev.dependencies] +coverage = "*" +ipykernel = "*" +ruff = "*" +pyright = "*" +pytest = "*" +{% if documentation %} +[tool.poetry.group.docs.dependencies] +mdx-truly-sane-lists = "*" +mkdocs = "*" +mkdocs-awesome-pages-plugin = "*" +mkdocs-material = "*" +mkdocs-video = "*" +pymdown-extensions = "*" +sphinx = "*" +sphinx-autodoc-typehints = "*" +sphinx-markdown-builder = "*" +{% endif %} +[build-system] +requires = ["poetry-core"] +build-backend = "poetry.core.masonry.api" diff --git a/template/pyrightconfig.json b/template/pyrightconfig.json new file mode 120000 index 0000000..9f031f9 --- /dev/null +++ b/template/pyrightconfig.json @@ -0,0 +1 @@ +../pyrightconfig.json \ No newline at end of file diff --git a/template/pytest.ini b/template/pytest.ini new file mode 120000 index 0000000..aa8b70b --- /dev/null +++ b/template/pytest.ini @@ -0,0 +1 @@ +../pytest.ini \ No newline at end of file diff --git a/template/ruff.toml.jinja b/template/ruff.toml.jinja new file mode 120000 index 0000000..851b505 --- /dev/null +++ b/template/ruff.toml.jinja @@ -0,0 +1 @@ +../ruff.toml \ No newline at end of file diff --git a/template/src/{{module_name}} b/template/src/{{module_name}} new file mode 120000 index 0000000..70c82c2 --- /dev/null +++ b/template/src/{{module_name}} @@ -0,0 +1 @@ +../../src/cookie \ No newline at end of file diff --git a/template/test/test_{{module_name}} b/template/test/test_{{module_name}} new file mode 120000 index 0000000..8b8381b --- /dev/null +++ b/template/test/test_{{module_name}} @@ -0,0 +1 @@ +../../test/test_cookie \ No newline at end of file diff --git a/template/{% if commitizen %}.cz.toml{% endif %}.jinja b/template/{% if commitizen %}.cz.toml{% endif %}.jinja new file mode 120000 index 0000000..24ff0f2 --- /dev/null +++ b/template/{% if commitizen %}.cz.toml{% endif %}.jinja @@ -0,0 +1 @@ +../.cz.toml \ No newline at end of file diff --git a/template/{% if documentation %}.apidoc_conf.py{% endif %}.jinja b/template/{% if documentation %}.apidoc_conf.py{% endif %}.jinja new file mode 100644 index 0000000..df7efd2 --- /dev/null +++ b/template/{% if documentation %}.apidoc_conf.py{% endif %}.jinja @@ -0,0 +1,40 @@ +# -- Project information ----------------------------------------------------- +project = "{{project_name}}" +copyright = "{{license}}" +author = "" + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + "sphinx.ext.autodoc", # main extension for generating from docstrings + "sphinx.ext.autosummary", # adds summary tables + "sphinx.ext.intersphinx", + "sphinx.ext.napoleon", # not sure this one works with the markdown builder + # The `sphinx_autodoc_typehints` extension must be loaded AFTER `sphinx.ext.napoleon`. + "sphinx_autodoc_typehints", + "sphinx_markdown_builder", +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = [] + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = [] + +intersphinx_mapping = { + "python": ("https://docs.python.org/3/", None), +} + +always_document_param_types = True + +autosummary_generate = True # Turn on sphinx.ext.autosummary +autoclass_content = "class" +autodoc_class_signature = "separated" +autodoc_inherit_docstrings = True # If no docstring, inherit from base class +set_type_checking_flag = True # Enable 'expensive' imports for sphinx_autodoc_typehints +add_module_names = False # Remove namespaces from class/method signatures diff --git a/template/{% if documentation %}docs{% endif %} b/template/{% if documentation %}docs{% endif %} new file mode 120000 index 0000000..a9594bf --- /dev/null +++ b/template/{% if documentation %}docs{% endif %} @@ -0,0 +1 @@ +../docs \ No newline at end of file diff --git a/template/{% if documentation %}mkdocs.yml{% endif %}.jinja b/template/{% if documentation %}mkdocs.yml{% endif %}.jinja new file mode 100644 index 0000000..1f57bcb --- /dev/null +++ b/template/{% if documentation %}mkdocs.yml{% endif %}.jinja @@ -0,0 +1,86 @@ +site_name: "{{project_name}}" +repo_url: https://github.com/{{organization}}/{{project_name}} +repo_name: "{{project_name}}" +docs_dir: docs +theme: + name: material + logo: images/logo.png + favicon: images/favicon.ico + palette: + # Palette toggle for automatic mode + - media: "(prefers-color-scheme)" + toggle: + icon: material/brightness-auto + name: Switch to light mode + + # Palette toggle for light mode + - media: "(prefers-color-scheme: light)" + scheme: default + toggle: + icon: material/brightness-7 + name: Switch to dark mode + + # Palette toggle for dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + toggle: + icon: material/brightness-4 + name: Switch to light mode + icon: + repo: fontawesome/brands/github-alt + features: + - navigation.sections + - navigation.expand + - navigation.instant + - navigation.instant.prefetch + - navigation.path + - content.code.copy + - toc.follow + - navigation.top +extra_css: + - css/extra.css +# removed because of codeql detection +# https://github.com/{{organization}}/{{project_name}}/security/code-scanning/3 +# https://github.com/{{organization}}/{{project_name}}/security/code-scanning/4 +#extra_javascript: +# - js/mathjax.js +# - js/tex-mml-chtml.js +plugins: + - search + - awesome-pages + - mkdocs-video: + is_video: true + video_controls: true +markdown_extensions: + # Allows for nicely styled notes and warnings: !!! note + - admonition + # Allows for adding attributes to markdown content: !(some-image){: align=left } + - attr_list + - md_in_html + - pymdownx.details + - pymdownx.highlight: + anchor_linenums: true + line_spans: __span + pygments_lang_class: true + - pymdownx.inlinehilite + - pymdownx.snippets + - pymdownx.magiclink + - pymdownx.superfences + - pymdownx.tabbed: + alternate_style: true + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg + - toc: + permalink: true + - def_list # definition / description lists + - pymdownx.tasklist: # Allows us to make a Tasklist: [x] some checked thing + custom_checkbox: true + # removed because of codeql detection + # https://github.com/{{organization}}/{{project_name}}/security/code-scanning/3 + # https://github.com/{{organization}}/{{project_name}}/security/code-scanning/4 + # - pymdownx.arithmatex: + # generic: true + # Needed because sphinx is generating lists with 2 spaces which is not supported by mkdocs + # See: https://github.com/mkdocs/mkdocs/issues/545 + - mdx_truly_sane_lists diff --git a/template/{% if microsoft_internal %}.azure-pipelines{% endif %} b/template/{% if microsoft_internal %}.azure-pipelines{% endif %} new file mode 120000 index 0000000..f0a1bb2 --- /dev/null +++ b/template/{% if microsoft_internal %}.azure-pipelines{% endif %} @@ -0,0 +1 @@ +../.azure-pipelines \ No newline at end of file diff --git a/template/{% if microsoft_internal %}CODE_OF_CONDUCT.md{% endif %}.jinja b/template/{% if microsoft_internal %}CODE_OF_CONDUCT.md{% endif %}.jinja new file mode 120000 index 0000000..0400d57 --- /dev/null +++ b/template/{% if microsoft_internal %}CODE_OF_CONDUCT.md{% endif %}.jinja @@ -0,0 +1 @@ +../CODE_OF_CONDUCT.md \ No newline at end of file diff --git a/template/{% if microsoft_internal %}SECURITY.md{% endif %}.jinja b/template/{% if microsoft_internal %}SECURITY.md{% endif %}.jinja new file mode 120000 index 0000000..9d57138 --- /dev/null +++ b/template/{% if microsoft_internal %}SECURITY.md{% endif %}.jinja @@ -0,0 +1 @@ +../SECURITY.md \ No newline at end of file diff --git a/template/{% if not microsoft_internal %}CODE_OF_CONDUCT.md{% endif %}.jinja b/template/{% if not microsoft_internal %}CODE_OF_CONDUCT.md{% endif %}.jinja new file mode 100644 index 0000000..67fe8ce --- /dev/null +++ b/template/{% if not microsoft_internal %}CODE_OF_CONDUCT.md{% endif %}.jinja @@ -0,0 +1,132 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official email address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +[INSERT CONTACT METHOD]. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/template/{% if not microsoft_internal %}SECURITY.md{% endif %}.jinja b/template/{% if not microsoft_internal %}SECURITY.md{% endif %}.jinja new file mode 100644 index 0000000..5d5028d --- /dev/null +++ b/template/{% if not microsoft_internal %}SECURITY.md{% endif %}.jinja @@ -0,0 +1,8 @@ +## Security + +If you believe you have found a security vulnerability in this repository, +please report it to us as described below. + +## Reporting Security Issues + +TO COMPLETE... diff --git a/template/{% if precommit %}.pre-commit-config.yaml{% endif %}.jinja b/template/{% if precommit %}.pre-commit-config.yaml{% endif %}.jinja new file mode 100644 index 0000000..082dbcb --- /dev/null +++ b/template/{% if precommit %}.pre-commit-config.yaml{% endif %}.jinja @@ -0,0 +1,70 @@ +ci: + autofix_prs: false + autoupdate_commit_msg: ":arrow-up: dep-bump(pre-commit): update pre-commit hooks" + +default_install_hook_types: [pre-commit, commit-msg] + +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.6.0 + hooks: + - id: check-ast + - id: check-added-large-files + - id: check-case-conflict + - id: check-docstring-first + - id: check-executables-have-shebangs + - id: check-merge-conflict + - id: check-shebang-scripts-are-executable + - id: check-symlinks + - id: check-toml + - id: check-xml + exclude: (?x)(^.idea/) + - id: check-yaml + args: ["--unsafe"] + - id: debug-statements + - id: detect-private-key + - id: end-of-file-fixer + - id: forbid-submodules + - id: trailing-whitespace + + - repo: https://gitlab.com/bmares/check-json5 + rev: v1.0.0 + hooks: + - id: check-json5 + + - repo: https://github.com/astral-sh/ruff-pre-commit + rev: v0.4.3 + hooks: + - id: ruff # linter + name: ruff-check + types_or: [python, pyi, jupyter] + args: [--fix] + - id: ruff-format # formatter + types_or: [python, pyi, jupyter] +{% if commitizen %} + - repo: https://github.com/commitizen-tools/commitizen + rev: v3.25.0 + hooks: + - id: commitizen + additional_dependencies: [cz-conventional-gitmoji] + + - repo: https://github.com/ljnsn/cz-conventional-gitmoji + rev: v0.3.1 + hooks: + - id: conventional-gitmoji +{% endif %} +{%- if documentation %} + - repo: https://github.com/asottile/blacken-docs + rev: 1.16.0 + hooks: + - id: blacken-docs + additional_dependencies: [black] +{% endif %} + - repo: https://github.com/codespell-project/codespell + rev: v2.2.6 + hooks: + - id: codespell + name: Run codespell to check for common misspellings in files + language: python + types: [text] + exclude: "poetry.lock|CHANGELOG.md" diff --git a/template/{{project_name}}.code-workspace.jinja b/template/{{project_name}}.code-workspace.jinja new file mode 120000 index 0000000..9fe4e92 --- /dev/null +++ b/template/{{project_name}}.code-workspace.jinja @@ -0,0 +1 @@ +../cookie-doh.code-workspace \ No newline at end of file diff --git a/test/python/{{module_name}}_test/__init__.py b/test/test_cookie/__init__.py similarity index 100% rename from test/python/{{module_name}}_test/__init__.py rename to test/test_cookie/__init__.py diff --git a/test/python/{{module_name}}_test/test_example.py b/test/test_cookie/test_example.py similarity index 100% rename from test/python/{{module_name}}_test/test_example.py rename to test/test_cookie/test_example.py diff --git a/{{project_name}}.code-workspace.jinja b/{{project_name}}.code-workspace.jinja deleted file mode 120000 index ff80164..0000000 --- a/{{project_name}}.code-workspace.jinja +++ /dev/null @@ -1 +0,0 @@ -cookie-doh.code-workspace \ No newline at end of file