From 295c9ed6c730956505607c28d376287d94dccc87 Mon Sep 17 00:00:00 2001 From: Daniil Fajnberg Date: Thu, 9 Mar 2023 12:08:59 +0100 Subject: [PATCH] Major overhaul: - transition to `pyproject.toml` config - include license (Apache-2.0) - add dev tools - add documentation config (`mkdocs` based) - turn `README.md` into a symlink to docs `index.md` - add convenience scripts for testing and linting --- .coveragerc | 12 --- .gitea/template | 6 +- .gitignore | 21 +++- LICENSE | 201 +++++++++++++++++++++++++++++++++++ README.md | 20 +--- coverage.sh | 3 - docs/css/extra.css | 0 docs/index.md | 15 +++ mkdocs.yaml | 38 +++++++ pyproject.toml | 101 +++++++++++++++++- requirements/dev.txt | 6 ++ scripts/lint.sh | 16 +++ scripts/test.sh | 17 +++ setup.cfg | 29 ----- src/package_name/__init__.py | 20 ++++ tests/__main__.py | 13 +++ 16 files changed, 446 insertions(+), 72 deletions(-) delete mode 100644 .coveragerc create mode 100644 LICENSE mode change 100644 => 120000 README.md delete mode 100755 coverage.sh create mode 100644 docs/css/extra.css create mode 100644 docs/index.md create mode 100644 mkdocs.yaml create mode 100644 scripts/lint.sh create mode 100644 scripts/test.sh delete mode 100644 setup.cfg create mode 100644 tests/__main__.py diff --git a/.coveragerc b/.coveragerc deleted file mode 100644 index 11a7f12..0000000 --- a/.coveragerc +++ /dev/null @@ -1,12 +0,0 @@ -[run] -source = src/ -branch = true -omit = - .venv/* - -[report] -fail_under = 100 -show_missing = True -skip_covered = False -omit = - tests/* diff --git a/.gitea/template b/.gitea/template index 426475e..ba40162 100644 --- a/.gitea/template +++ b/.gitea/template @@ -1,2 +1,4 @@ -README.md -setup.cfg +mkdocs.yaml +pyproject.toml +docs/index.md +src/**.py diff --git a/.gitignore b/.gitignore index 22ce824..0b5744a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,10 +1,25 @@ # Python virtual environment: -/.venv/ +/.venv*/ +/venv*/ +/.env*/ +/env*/ + # IDE settings: /.idea/ /.vscode/ -# Distribution / packaging: + +# Distribution / build files: *.egg-info/ /dist/ -# Python cache: +/docs/build/ +/site/ + +# Python cache / compiled files: __pycache__/ +*.py[cod] + +# Testing: +/.coverage + +# mypy: +.mypy_cache/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + 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. diff --git a/README.md b/README.md deleted file mode 100644 index 32ec030..0000000 --- a/README.md +++ /dev/null @@ -1,19 +0,0 @@ -# ${REPO_NAME} - -${REPO_DESCRIPTION} - -## Usage - -... - -## Installation - -`pip install ${REPO_NAME}` - -## Dependencies - -Python Version ..., OS ... - -## Building from source - -Run `python -m build` diff --git a/README.md b/README.md new file mode 120000 index 0000000..e892330 --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +docs/index.md \ No newline at end of file diff --git a/coverage.sh b/coverage.sh deleted file mode 100755 index 786075e..0000000 --- a/coverage.sh +++ /dev/null @@ -1,3 +0,0 @@ -#!/usr/bin/env sh - -coverage erase && coverage run -m unittest discover && coverage report diff --git a/docs/css/extra.css b/docs/css/extra.css new file mode 100644 index 0000000..e69de29 diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..b624b95 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,15 @@ +# ${REPO_NAME} + +${REPO_DESCRIPTION} + +## Usage + +... + +## Installation + +`pip install ${REPO_NAME}` + +## Dependencies + +Python Version ..., OS ... diff --git a/mkdocs.yaml b/mkdocs.yaml new file mode 100644 index 0000000..05612c2 --- /dev/null +++ b/mkdocs.yaml @@ -0,0 +1,38 @@ +copyright: "© 2023 ${REPO_OWNER_TITLE}" +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 + +markdown_extensions: + - admonition + - codehilite + - extra + - pymdownx.superfences + +nav: + - Home: index.md diff --git a/pyproject.toml b/pyproject.toml index b5a3c46..79848de 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,99 @@ +##################### +# Python packaging: # + [build-system] -requires = [ - "setuptools>=42", - "wheel" +requires = ["setuptools", "setuptools-scm"] +build-backend = "setuptools.build_meta" + +[project] +name = "${REPO_NAME}" +description = "${REPO_DESCRIPTION}" +authors = [ + { name = "${REPO_OWNER_TITLE}", email = "mail@PLACEHOLDER.to" }, +] +maintainers = [ + { name = "${REPO_OWNER_TITLE}", email = "mail@PLACEHOLDER.to" }, +] +requires-python = ">=3.9, <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", + "build", + "coverage", + "flake8", + "mkdocs-material", + "mkdocstrings[python]", + "mypy", +] + +[project.urls] +repository = "https://github.com/${REPO_OWNER_LOWER}/${REPO_NAME_LOWER}" +bug_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/common.txt" } +readme = { file = ["README.md"] } +version = {attr = "PACKAGE_NAME_PLACEHOLDER.__version__"} + +######### +# Mypy: # + +[tool.mypy] +files = "src/" +warn_unused_configs = true +strict = true +show_error_codes = true +plugins = [ + +] + +############# +# Coverage: # + +[tool.coverage.run] +source = [ + "src/", +] +branch = true +command_line = "-m tests" +omit = [ + ".venv*/*", +] + +[tool.coverage.report] +show_missing = true +skip_covered = false +exclude_lines = [ + "if TYPE_CHECKING:", + '''if __name__ == ['"]__main__['"]:''', + "@overload", +] +omit = [ + "tests/*", ] -build-backend = "setuptools.build_meta" \ No newline at end of file diff --git a/requirements/dev.txt b/requirements/dev.txt index f34043b..538c836 100644 --- a/requirements/dev.txt +++ b/requirements/dev.txt @@ -1,2 +1,8 @@ -r common.txt +black +build coverage +flake8 +mkdocs-material +mkdocstrings[python] +mypy diff --git a/scripts/lint.sh b/scripts/lint.sh new file mode 100644 index 0000000..7bf4a58 --- /dev/null +++ b/scripts/lint.sh @@ -0,0 +1,16 @@ +#!/usr/bin/env bash +# Runs type checker and linters. + +# 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)))" + +echo 'Performing type checks...' +mypy +echo + +echo 'Linting source and test files...' +flake8 src/ tests/ +echo -e 'No issues found.' diff --git a/scripts/test.sh b/scripts/test.sh new file mode 100644 index 0000000..a0d41fe --- /dev/null +++ b/scripts/test.sh @@ -0,0 +1,17 @@ +#!/usr/bin/env bash +# Runs unit tests and prints only coverage percentage, if successful. +# If an error occurs, prints the entire unit tests progress output. + +# Ensure that we return to the current working directory in case of an error: +trap "cd $(realpath ${PWD})" ERR +# Change into project root directory: +cd "$(dirname $(dirname $(realpath $0)))" + +coverage erase +# Capture the test progression in a variable: +typeset progress +progress=$(coverage run 2>&1) +# If tests failed or produced errors, write progress/messages to stderr and exit: +[[ $? -eq 0 ]] || { >&2 echo "${progress}"; exit 1; } +# Otherwise extract the total coverage percentage from the produced report and write it to stdout: +coverage report | awk '$1 == "TOTAL" {print $NF; exit}' diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index 827ede1..0000000 --- a/setup.cfg +++ /dev/null @@ -1,29 +0,0 @@ -[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 = https://git.fajnberg.de${REPO_LINK} -project_urls = - Bug Tracker = https://git.fajnberg.de${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 diff --git a/src/package_name/__init__.py b/src/package_name/__init__.py index e69de29..38a8f4f 100644 --- a/src/package_name/__init__.py +++ b/src/package_name/__init__.py @@ -0,0 +1,20 @@ +__copyright__ = "© 2023 ${REPO_OWNER_TITLE}" +__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__ = """ +PLACEHOLDER +""" diff --git a/tests/__main__.py b/tests/__main__.py new file mode 100644 index 0000000..fa3bae6 --- /dev/null +++ b/tests/__main__.py @@ -0,0 +1,13 @@ +import sys +import unittest + + +if __name__ == "__main__": + try: + pattern = sys.argv[1] + except IndexError: + pattern = "test*.py" + test_suite = unittest.defaultTestLoader.discover(".", pattern=pattern) + test_runner = unittest.TextTestRunner(resultclass=unittest.TextTestResult) + result = test_runner.run(test_suite) + sys.exit(not result.wasSuccessful())