added task file

Author: LostInDarkMath

.github/workflows/main.yml

@@ -20,12 +20,11 @@ jobs:
         check-latest: true
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip
+        task dependencies
         pip install -U coveralls
-        pip install -e .[dev]
     - name: Run tests with pytest
       run: |
-        pytest --doctest-modules --cov=pedantic --cov-branch --cov-report= --cov-report=term
+        task tests-with-cov
     - name: Coveralls
       uses: coverallsapp/github-action@v2.3.6
       with:
@@ -53,4 +52,4 @@ jobs:
    - name: Build and Upload to PyPI
      run: |
        python -m build
-       twine upload dist/*
+       twine upload dist/*

CHANGELOG.md

@@ -7,6 +7,9 @@
 - removed decorator `@timer`
 - removed decorator `@timer_class`
 - removed decorator `@uminplemented`
+- added `Taskfile.yml` and use it in CI
+- removed `create_pdoc.sh`
+- moved `examples` out of the package
 
 ## Pedantic 2.4.0
 - migrate from unittest to pytest

README.md

@@ -144,26 +144,19 @@ if __name__ == '__main__':
 ```
 
 ## List of all decorators in this package
-- [@count_calls](https://lostindarkmath.github.io/pedantic-python-decorators/pedantic/decorators/fn_deco_count_calls.html)
 - [@deprecated](https://lostindarkmath.github.io/pedantic-python-decorators/pedantic/decorators/fn_deco_deprecated.html)
-- [@does_same_as_function](https://lostindarkmath.github.io/pedantic-python-decorators/pedantic/decorators/fn_deco_does_same_as_function.html)
 - [@frozen_dataclass](https://lostindarkmath.github.io/pedantic-python-decorators/pedantic/decorators/cls_deco_frozen_dataclass.html#pedantic.decorators.cls_deco_frozen_dataclass.frozen_dataclass)
 - [@frozen_type_safe_dataclass](https://lostindarkmath.github.io/pedantic-python-decorators/pedantic/decorators/cls_deco_frozen_dataclass.html#pedantic.decorators.cls_deco_frozen_dataclass.frozen_type_safe_dataclass)
 - [@for_all_methods](https://lostindarkmath.github.io/pedantic-python-decorators/pedantic/decorators/class_decorators.html#pedantic.decorators.class_decorators.for_all_methods)
 - [@in_subprocess](https://lostindarkmath.github.io/pedantic-python-decorators/pedantic/decorators/fn_deco_in_subprocess.html)
-- [@mock](https://lostindarkmath.github.io/pedantic-python-decorators/pedantic/decorators/fn_deco_mock.html)
 - [@overrides](https://lostindarkmath.github.io/pedantic-python-decorators/pedantic/decorators/fn_deco_overrides.html)
 - [@pedantic](https://lostindarkmath.github.io/pedantic-python-decorators/pedantic/decorators/fn_deco_pedantic.html#pedantic.decorators.fn_deco_pedantic.pedantic)
 - [@pedantic_class](https://lostindarkmath.github.io/pedantic-python-decorators/pedantic/decorators/class_decorators.html#pedantic.decorators.class_decorators.pedantic_class)
-- [@rename_kwargs](https://lostindarkmath.github.io/pedantic-python-decorators/pedantic/decorators/fn_deco_rename_kwargs.html)
 - [@require_kwargs](https://lostindarkmath.github.io/pedantic-python-decorators/pedantic/decorators/fn_deco_require_kwargs.html)
 - [@retry](https://lostindarkmath.github.io/pedantic-python-decorators/pedantic/decorators/fn_deco_retry.html)
-- [@timer](https://lostindarkmath.github.io/pedantic-python-decorators/pedantic/decorators/fn_deco_timer.html)
-- [@timer_class](https://lostindarkmath.github.io/pedantic-python-decorators/pedantic/decorators/class_decorators.html#pedantic.decorators.class_decorators.timer_class)
 - [@trace](https://lostindarkmath.github.io/pedantic-python-decorators/pedantic/decorators/fn_deco_trace.html)
 - [@trace_class](https://lostindarkmath.github.io/pedantic-python-decorators/pedantic/decorators/class_decorators.html#pedantic.decorators.class_decorators.trace_class)
 - [@trace_if_returns](https://lostindarkmath.github.io/pedantic-python-decorators/pedantic/decorators/fn_deco_trace_if_returns.html)
-- [@unimplemented](https://lostindarkmath.github.io/pedantic-python-decorators/pedantic/decorators/fn_deco_unimplemented.html)
 - [@validate](https://lostindarkmath.github.io/pedantic-python-decorators/pedantic/decorators/fn_deco_validate/fn_deco_validate.html)
 
 ## List of all mixins in this package
@@ -183,12 +176,7 @@ There are no hard dependencies. But if you want to use some advanced features yo
   - `GenericFlaskDeserializer`
 
 ## Contributing
-Feel free to contribute by submitting a pull request :)
-
-## Acknowledgments
-* [Rathaustreppe](https://github.com/rathaustreppe)
-* [Aran-Fey](https://stackoverflow.com/questions/55503673/how-do-i-check-if-a-value-matches-a-type-in-python/55504010#55504010)
-* [user395760](https://stackoverflow.com/questions/55503673/how-do-i-check-if-a-value-matches-a-type-in-python/55504010#55504010)
+This project is based on [poetry](https://python-poetry.org/) and [taskfile](https://taskfile.dev).
 
 ## Risks and side effects
 The usage of decorators may affect the performance of your application. 

Taskfile.yml

@@ -0,0 +1,27 @@
+# yaml-language-server: $schema=https://taskfile.dev/schema.json
+
+version: '3'
+
+tasks:
+  dependencies:
+    desc: Updates the poetry.lock file and installs all dependencies
+    cmds:
+      - pip install --upgrade pip
+      - poetry lock
+      - poetry install --extras dev
+    silent: true
+  tests:
+    desc: Runs the tests
+    cmds:
+      - pytest --doctest-modules
+  tests-with-cov:
+    desc: Runs the tests with coverage
+    cmds:
+      - pytest --doctest-modules --cov=pedantic --cov-branch --cov-report= --cov-report=term
+  docs:
+    desc: Creates the HTML documentation
+    cmds:
+      - rm -rf ./docs
+      - pip install pdoc
+      - pdoc -o docs pedantic
+      - google-chrome ./docs/index.html

create_pdoc.sh

@@ -0,0 +1,7 @@
+<!doctype html>
+<html>
+<head>
+    <meta charset="utf-8">
+    <meta http-equiv="refresh" content="0; url=./pedantic.html"/>
+</head>
+</html>