feat: simplify library interface

BREAKING CHANGE: simplify library interface. See new README.md

.markdownlint.yaml

@@ -0,0 +1,5 @@
+# default to true for all rules
+default: true
+
+# MD013/line-length
+MD013: false

.pre-commit-config.yaml

@@ -4,6 +4,28 @@ fail_fast: true
 default_language_version:
   python: python3.9
 repos:
+  - repo: https://github.com/abravalheri/validate-pyproject
+    rev: v0.23
+    hooks:
+      - id: validate-pyproject
+  - repo: https://github.com/executablebooks/mdformat
+    rev: 0.7.19
+    hooks:
+      - id: mdformat
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.43.0
+    hooks:
+      - id: markdownlint-fix
+  - repo: https://github.com/adamchainz/blacken-docs
+    rev: 1.19.1
+    hooks:
+      - id: blacken-docs
+        additional_dependencies:
+          - black==24.10.0
+  - repo: https://github.com/crate-ci/typos
+    rev: v1.28.1
+    hooks:
+      - id: typos
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v5.0.0
     hooks:

CONTRIBUTING.md

@@ -12,31 +12,31 @@ I recommend to create an issue.
 
 ## Developing
 
-* The development branch is `develop`.
-* All pull requests should be opened against `develop`.
-* The changes on the `develop` branch are published to https://test.pypi.org/project/autoload-module/ .
-    * You can install the `develop` package by
-      executing `pip install -i https://test.pypi.org/simple/ autoload-module` .
+- The development branch is `develop`.
+- All pull requests should be opened against `develop`.
+- The changes on the `develop` branch are published to [Test PyPI](https://test.pypi.org/project/autoload-module/) .
+  - You can install the `develop` package by
+    executing `pip install -i https://test.pypi.org/simple/ autoload-module` .
 
 To develop locally:
 
 1. Install [poetry](https://python-poetry.org/docs/) .
-2. Clone this repository.
-3. Create a new branch.
-4. Install the dependencies with:
-   `poetry install`
-5. Enable [`pre-commit`](https://pre-commit.com/) .
+1. Clone this repository.
+1. Create a new branch.
+1. Install the dependencies with:
+   `poetry install --all-extras`
+1. Enable [`pre-commit`](https://pre-commit.com/) .
 
 ## Testing
 
-* Please update the tests to reflect your code changes.
-* Pull requests will not be accepted if they are failing on GitHub Actions.
-* You can also check your code by executing `python -m unittest` .
+- Please update the tests to reflect your code changes.
+- Pull requests will not be accepted if they are failing on GitHub Actions.
+- You can also check your code by executing `poetry run pytest` .
 
 ## Docs
 
 I'm not familiar with English, so I especially thank you for documents' corrections.
 
 ## Release
 
-I release `autoload-module` by merging from `develop` into `master` branch.
+I release `autoload-module` by merging from `develop` into `master` branch.