Compare commits
No commits in common. "master" and "ddd0e697cc1a1c200553aac1bc34241dbf8be548" have entirely different histories.
master
...
ddd0e697cc
|
@ -0,0 +1,12 @@
|
|||
[run]
|
||||
source = src/
|
||||
branch = true
|
||||
omit =
|
||||
.venv/*
|
||||
|
||||
[report]
|
||||
fail_under = 100
|
||||
show_missing = True
|
||||
skip_covered = False
|
||||
omit =
|
||||
tests/*
|
|
@ -1,4 +1,2 @@
|
|||
mkdocs.yaml
|
||||
pyproject.toml
|
||||
docs/index.md
|
||||
src/**.py
|
||||
README.md
|
||||
setup.cfg
|
||||
|
|
|
@ -1,34 +0,0 @@
|
|||
name: CI
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [master]
|
||||
tags: ['v*.*.*']
|
||||
|
||||
jobs:
|
||||
test:
|
||||
name: Test
|
||||
uses: daniil-berg/reusable-workflows/.github/workflows/python-test.yaml@v0.2.2
|
||||
with:
|
||||
versions: '["3.9", "3.10", "3.11", "3.12"]'
|
||||
unittest-command: 'scripts/test.sh'
|
||||
coverage-command: 'scripts/cov.sh'
|
||||
unittest-requirements: "-e '.[dev]'"
|
||||
typecheck-command: 'scripts/typecheck.sh'
|
||||
typecheck-requirements: '-Ur requirements/dev.txt'
|
||||
typecheck-all-versions: true
|
||||
lint-command: 'scripts/lint.sh'
|
||||
lint-requirements: '-Ur requirements/dev.txt'
|
||||
|
||||
release:
|
||||
name: Release
|
||||
if: ${{ github.ref_type == 'tag' }}
|
||||
needs: test
|
||||
uses: daniil-berg/reusable-workflows/.github/workflows/python-release.yaml@v0.2.2
|
||||
with:
|
||||
git-ref: ${{ github.ref_name }}
|
||||
secrets:
|
||||
release-token: ${{ secrets.TOKEN_GITHUB_CREATE_RELEASE }}
|
||||
publish-token: ${{ secrets.TOKEN_PYPI_PROJECT }}
|
||||
permissions:
|
||||
contents: write
|
|
@ -1,22 +1,10 @@
|
|||
# Python virtual environment:
|
||||
/.venv*/
|
||||
/venv*/
|
||||
/.env*/
|
||||
/env*/
|
||||
|
||||
/.venv/
|
||||
# IDE settings:
|
||||
/.idea/
|
||||
/.vscode/
|
||||
|
||||
# Distribution / build files:
|
||||
# Distribution / packaging:
|
||||
*.egg-info/
|
||||
/dist/
|
||||
/docs/build/
|
||||
/site/
|
||||
|
||||
# Python cache / compiled files:
|
||||
# Python cache:
|
||||
__pycache__/
|
||||
*.py[cod]
|
||||
|
||||
# Miscellaneous cache:
|
||||
.cache/
|
||||
|
|
201
LICENSE
201
LICENSE
|
@ -1,201 +0,0 @@
|
|||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
|
@ -0,0 +1,19 @@
|
|||
# ${REPO_NAME}
|
||||
|
||||
${REPO_DESCRIPTION}
|
||||
|
||||
## Usage
|
||||
|
||||
...
|
||||
|
||||
## Installation
|
||||
|
||||
`pip install ${REPO_NAME}`
|
||||
|
||||
## Dependencies
|
||||
|
||||
Python Version ..., OS ...
|
||||
|
||||
## Building from source
|
||||
|
||||
Run `python -m build`
|
|
@ -0,0 +1,3 @@
|
|||
#!/usr/bin/env sh
|
||||
|
||||
coverage erase && coverage run -m unittest discover && coverage report
|
|
@ -1,3 +0,0 @@
|
|||
.md-typeset code {
|
||||
word-break: keep-all; /* Prevent inline-code from being broken up. */
|
||||
}
|
|
@ -1,29 +0,0 @@
|
|||
# ${REPO_NAME}
|
||||
|
||||
**${REPO_DESCRIPTION}**
|
||||
|
||||
---
|
||||
|
||||
[📑 Documentation][1] | [🧑💻 Source Code][2] | [🐛 Bug Tracker][3]
|
||||
|
||||
---
|
||||
|
||||
## Installation
|
||||
|
||||
`pip install ${REPO_NAME}`
|
||||
|
||||
## Usage
|
||||
|
||||
...
|
||||
|
||||
## Dependencies
|
||||
|
||||
Python `>=3.8`, OS agnostic
|
||||
|
||||
---
|
||||
|
||||
© 2023 ...
|
||||
|
||||
[1]: https://${REPO_OWNER_LOWER}.github.io/${REPO_NAME_LOWER}
|
||||
[2]: https://github.com/${REPO_OWNER_LOWER}/${REPO_NAME_LOWER}
|
||||
[3]: https://github.com/${REPO_OWNER_LOWER}/${REPO_NAME_LOWER}/issues
|
48
mkdocs.yaml
48
mkdocs.yaml
|
@ -1,48 +0,0 @@
|
|||
... copyright: "© 2023 ..."
|
||||
site_name: "${REPO_NAME}"
|
||||
site_description: "${REPO_DESCRIPTION}"
|
||||
site_url: "http://${REPO_OWNER_LOWER}.github.io/${REPO_NAME_LOWER}"
|
||||
repo_name: "${REPO_OWNER_LOWER}/${REPO_NAME_LOWER}"
|
||||
repo_url: "https://github.com/${REPO_OWNER_LOWER}/${REPO_NAME_LOWER}"
|
||||
|
||||
theme:
|
||||
language: en
|
||||
name: material
|
||||
palette:
|
||||
- media: "(prefers-color-scheme: light)"
|
||||
scheme: default
|
||||
accent: red
|
||||
toggle:
|
||||
icon: material/brightness-7
|
||||
name: Switch to dark mode
|
||||
- media: "(prefers-color-scheme: dark)"
|
||||
scheme: slate
|
||||
accent: red
|
||||
toggle:
|
||||
icon: material/brightness-4
|
||||
name: Switch to light mode
|
||||
extra_css:
|
||||
- css/extra.css
|
||||
|
||||
plugins:
|
||||
- search
|
||||
- mkdocstrings:
|
||||
handlers:
|
||||
python:
|
||||
options:
|
||||
line_length: 80
|
||||
show_source: false
|
||||
show_root_toc_entry: false
|
||||
separate_signature: true
|
||||
show_signature_annotations: true
|
||||
|
||||
markdown_extensions:
|
||||
- admonition
|
||||
- codehilite
|
||||
- extra
|
||||
- pymdownx.superfences
|
||||
- toc:
|
||||
permalink: true
|
||||
|
||||
nav:
|
||||
- Home: index.md
|
189
pyproject.toml
189
pyproject.toml
|
@ -1,189 +1,6 @@
|
|||
#####################
|
||||
# Python packaging: #
|
||||
|
||||
[build-system]
|
||||
requires = [
|
||||
"setuptools",
|
||||
"setuptools-scm",
|
||||
"setuptools>=42",
|
||||
"wheel"
|
||||
]
|
||||
build-backend = "setuptools.build_meta"
|
||||
|
||||
[project]
|
||||
name = "${REPO_NAME}"
|
||||
description = "${REPO_DESCRIPTION}"
|
||||
authors = [
|
||||
{ name = ..., email = ... },
|
||||
]
|
||||
maintainers = [
|
||||
{ name = ..., email = ... },
|
||||
]
|
||||
requires-python = ">=3.8, <4.0"
|
||||
keywords = [
|
||||
...
|
||||
]
|
||||
license = { text = "Apache Software License Version 2.0" }
|
||||
classifiers = [
|
||||
"Development Status :: 4 - Beta",
|
||||
"Programming Language :: Python :: 3 :: Only",
|
||||
"Programming Language :: Python :: 3.9",
|
||||
"Programming Language :: Python :: 3.10",
|
||||
"Programming Language :: Python :: 3.11",
|
||||
"Operating System :: OS Independent",
|
||||
"License :: OSI Approved :: Apache Software License",
|
||||
# "Intended Audience :: Developers",
|
||||
# "Framework :: AsyncIO",
|
||||
# "Topic :: Internet",
|
||||
...
|
||||
]
|
||||
dynamic = [
|
||||
"dependencies",
|
||||
"readme",
|
||||
"version",
|
||||
]
|
||||
|
||||
[project.optional-dependencies]
|
||||
full = []
|
||||
dev = [
|
||||
"black==23.10.1",
|
||||
"build==1.0.3",
|
||||
"coverage[toml]==7.3.2",
|
||||
"isort==5.12.0",
|
||||
"mkdocs-material==9.4.6",
|
||||
"mkdocstrings[python]==0.23.0",
|
||||
"mypy==1.5.1",
|
||||
"pytest==7.4.3",
|
||||
"ruff==0.1.3",
|
||||
]
|
||||
|
||||
[project.urls]
|
||||
"Repository" = "https://github.com/${REPO_OWNER_LOWER}/${REPO_NAME_LOWER}"
|
||||
"Issue Tracker" = "https://github.com/${REPO_OWNER_LOWER}/${REPO_NAME_LOWER}/issues"
|
||||
"Documentation" = "http://${REPO_OWNER_LOWER}.github.io/${REPO_NAME_LOWER}"
|
||||
|
||||
[tool.setuptools.dynamic]
|
||||
dependencies = { file = "requirements/base.txt" }
|
||||
readme = { file = ["README.md"], content-type = "text/markdown" }
|
||||
version = { attr = ..."${REPO_NAME}.__version__" }
|
||||
|
||||
#########################
|
||||
# Static type checking: #
|
||||
|
||||
[tool.mypy]
|
||||
cache_dir = ".cache/mypy"
|
||||
files = [
|
||||
"src/",
|
||||
"tests/",
|
||||
]
|
||||
warn_unused_configs = true
|
||||
strict = true
|
||||
show_error_codes = true
|
||||
plugins = []
|
||||
|
||||
############
|
||||
# Testing: #
|
||||
|
||||
[tool.pytest.ini_options]
|
||||
cache_dir = ".cache/pytest"
|
||||
addopts = "-ra -v"
|
||||
testpaths = [
|
||||
"tests",
|
||||
]
|
||||
|
||||
#######################
|
||||
# Unit test coverage: #
|
||||
|
||||
[tool.coverage.run]
|
||||
data_file = ".cache/coverage"
|
||||
source = [
|
||||
"src/",
|
||||
]
|
||||
branch = true
|
||||
command_line = "-m pytest -qq"
|
||||
omit = [
|
||||
".venv*/*",
|
||||
]
|
||||
|
||||
[tool.coverage.report]
|
||||
show_missing = true
|
||||
skip_covered = false
|
||||
exclude_lines = [
|
||||
"if TYPE_CHECKING:",
|
||||
'''if __name__ == ['"]__main__['"]:''',
|
||||
"@overload",
|
||||
]
|
||||
omit = [
|
||||
"tests/*",
|
||||
]
|
||||
|
||||
###############################
|
||||
# Linting and style checking: #
|
||||
|
||||
[tool.ruff]
|
||||
cache-dir = ".cache/ruff"
|
||||
select = [
|
||||
"F", # pyflakes
|
||||
"E", # pycodestyle errors
|
||||
"W", # pycodestyle warnings
|
||||
"N", # pep8-naming
|
||||
"D", # pydocstyle
|
||||
"ANN", # flake8-annotations
|
||||
"S", # flake8-bandit
|
||||
"FBT", # flake8-boolean-trap
|
||||
"B", # flake8-bugbear
|
||||
"A", # flake8-builtins
|
||||
"C", # flake8-comprehensions
|
||||
"PIE", # flake8-pie
|
||||
"T20", # flake8-print
|
||||
"RET", # flake8-return
|
||||
"SIM", # flake8-simplify
|
||||
"TD", # flake8-todos
|
||||
"TCH", # flake8-type-checking
|
||||
"ARG", # flake8-unused-arguments
|
||||
"PTH", # flake8-use-pathlib
|
||||
"ERA", # eradicate
|
||||
"PL", # pylint
|
||||
"TRY", # tryceratops
|
||||
"RUF", # ruff-specific
|
||||
]
|
||||
ignore = [
|
||||
"E501", # Line too long -> handled by black
|
||||
"D203", # 1 blank line required before class docstring -> D211 is better
|
||||
"D212", # Multi-line docstring summary should start at the first line -> ugly, D213 is better
|
||||
"D401", # First line of docstring should be in imperative mood -> no, it shouldn't
|
||||
"D407", # Missing dashed underline after section -> different docstring style
|
||||
"ANN101", # Missing type annotation for self in method -> unnecessary
|
||||
"ANN102", # Missing type annotation for cls in classmethod -> unnecessary
|
||||
"ANN401", # Dynamically typed expressions (typing.Any) are disallowed -> we'll use it sparingly
|
||||
"N818", # Exception name should be named with an Error suffix -> absolutely not
|
||||
]
|
||||
|
||||
[tool.ruff.per-file-ignores]
|
||||
"src/**/__init__.py" = [
|
||||
"A001", # Variable {name} is shadowing a Python builtin
|
||||
"D104", # Missing docstring in public package
|
||||
"F401", # {...} imported but unused
|
||||
]
|
||||
"tests/*.py" = [
|
||||
"D100", # Missing docstring in public module
|
||||
"D101", # Missing docstring in public class
|
||||
"D102", # Missing docstring in public method
|
||||
"D103", # Missing docstring in public function
|
||||
"D104", # Missing docstring in public package
|
||||
"S101", # Use of `assert` detected
|
||||
"FBT", # flake8-boolean-trap
|
||||
"TRY", # tryceratops
|
||||
]
|
||||
|
||||
####################
|
||||
# Code formatting: #
|
||||
|
||||
[tool.black]
|
||||
line_length = 80
|
||||
|
||||
###################
|
||||
# Import sorting: #
|
||||
|
||||
[tool.isort]
|
||||
profile = "black"
|
||||
extra_standard_library = ["typing_extensions"]
|
||||
line_length = 80
|
||||
build-backend = "setuptools.build_meta"
|
|
@ -1,10 +1,2 @@
|
|||
-r full.txt
|
||||
black==23.10.1
|
||||
build==1.0.3
|
||||
coverage[toml]==7.3.2
|
||||
isort==5.12.0
|
||||
mkdocs-material==9.4.6
|
||||
mkdocstrings[python]==0.23.0
|
||||
mypy==1.5.1
|
||||
pytest==7.4.3
|
||||
ruff==0.1.3
|
||||
-r common.txt
|
||||
coverage
|
||||
|
|
|
@ -1 +0,0 @@
|
|||
-r base.txt
|
|
@ -1,12 +0,0 @@
|
|||
#!/usr/bin/env bash
|
||||
# Runs full CI pipeline (test, typecheck, lint).
|
||||
|
||||
typeset scripts_dir="$(dirname $(realpath $0))"
|
||||
|
||||
source "${scripts_dir}/util.sh"
|
||||
|
||||
"${scripts_dir}/test.sh"
|
||||
"${scripts_dir}/typecheck.sh"
|
||||
"${scripts_dir}/lint.sh"
|
||||
|
||||
echo -e "${background_black}${bold_green}✅ 🎉 All checks passed!${color_reset}"
|
|
@ -1,10 +0,0 @@
|
|||
#!/usr/bin/env bash
|
||||
# Runs unit tests.
|
||||
# If successful, prints only the coverage percentage.
|
||||
# If an error occurs, prints the entire unit tests progress output.
|
||||
|
||||
source "$(dirname $(realpath $0))/util.sh"
|
||||
|
||||
coverage erase
|
||||
run_and_capture coverage run
|
||||
coverage report | awk '$1 == "TOTAL" {print $NF; exit}'
|
|
@ -1,17 +0,0 @@
|
|||
#!/usr/bin/env bash
|
||||
# Runs various linters.
|
||||
|
||||
source "$(dirname $(realpath $0))/util.sh"
|
||||
|
||||
echo 'Linting source and test files...'
|
||||
|
||||
echo ' ruff - Doing extensive linting'
|
||||
ruff src/ tests/
|
||||
|
||||
echo ' black - Ensuring consistent code style'
|
||||
run_and_capture black src/ tests/ --check
|
||||
|
||||
echo ' isort - Ensuring consistent import structure'
|
||||
isort src/ tests/ --check-only
|
||||
|
||||
echo -e "${bold_green}No issues found${color_reset}\n"
|
|
@ -1,12 +0,0 @@
|
|||
#!/usr/bin/env bash
|
||||
# Runs unit tests and reports coverage percentage.
|
||||
|
||||
source "$(dirname $(realpath $0))/util.sh"
|
||||
|
||||
echo 'Running unit tests...'
|
||||
coverage run
|
||||
typeset percentage
|
||||
typeset color
|
||||
percentage="$(coverage report | awk '$1 == "TOTAL" {print $NF; exit}')"
|
||||
[[ $percentage == "100%" ]] && color="${bold_green}" || color="${yellow}"
|
||||
echo -e "${color}${percentage} coverage${color_reset}\n"
|
|
@ -1,8 +0,0 @@
|
|||
#!/usr/bin/env bash
|
||||
# Runs type checker.
|
||||
|
||||
source "$(dirname $(realpath $0))/util.sh"
|
||||
|
||||
echo 'Performing type checks...'
|
||||
mypy
|
||||
echo
|
|
@ -1,20 +0,0 @@
|
|||
run_and_capture() {
|
||||
# Captures stderr of any command passed to it
|
||||
# and releases it only if the command exits with a non-zero code.
|
||||
typeset output
|
||||
output=$($@ 2>&1)
|
||||
typeset exit_status=$?
|
||||
[[ $exit_status == 0 ]] || >&2 echo "${output}"
|
||||
return $exit_status
|
||||
}
|
||||
|
||||
# Ensure that we return to the current working directory
|
||||
# and exit the script immediately in case of an error:
|
||||
trap "cd $(realpath ${PWD}); exit 1" ERR
|
||||
# Change into project root directory:
|
||||
cd "$(dirname $(dirname $(realpath $0)))"
|
||||
|
||||
typeset background_black='\033[40m'
|
||||
typeset bold_green='\033[1;92m'
|
||||
typeset yellow='\033[0;33m'
|
||||
typeset color_reset='\033[0m'
|
|
@ -0,0 +1,29 @@
|
|||
[metadata]
|
||||
name = ${REPO_NAME}
|
||||
version = 0.0.1
|
||||
author = ${REPO_OWNER_TITLE}
|
||||
author_email = mail@placeholder123.to
|
||||
description = ${REPO_DESCRIPTION}
|
||||
long_description = file: README.md
|
||||
long_description_content_type = text/markdown
|
||||
url = ${REPO_LINK}
|
||||
project_urls =
|
||||
Bug Tracker = ${REPO_LINK}/issues
|
||||
classifiers =
|
||||
Programming Language :: Python :: 3
|
||||
Operating System :: OS Independent
|
||||
|
||||
[options]
|
||||
package_dir =
|
||||
= src
|
||||
packages = find:
|
||||
python_requires = >=3
|
||||
install_requires =
|
||||
...
|
||||
|
||||
[options.extras_require]
|
||||
dev =
|
||||
coverage
|
||||
|
||||
[options.packages.find]
|
||||
where = src
|
|
@ -1,20 +0,0 @@
|
|||
... __copyright__ = "© 2023 ..."
|
||||
__license__ = """Apache-2.0
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License."""
|
||||
|
||||
__version__ = "0.0.1"
|
||||
|
||||
__doc__ = """
|
||||
${REPO_DESCRIPTION}
|
||||
"""
|
Loading…
Reference in New Issue