Move optional dependencies from dev_requirements to pyproject.toml (

#474) * Move optional dependencies from `dev_requirements` to `pyproject.toml` * Spellcheck update * Gitworkflows * typo * black & Isort * hatchlinger * Hatchlinger Update * fix hatchi * try3 * copy paste fehler --------- Co-authored-by: kevin <kevin.krechan@hochfrequenz.de>
Hochfrequenz · Sep 24, 2024 · 78c1851 · 78c1851
1 parent 557477b
commit 78c1851
Show file tree

Hide file tree

Showing 71 changed files with 131 additions and 290 deletions.
diff --git a/.github/workflows/black.yml b/.github/workflows/black.yml
@@ -18,7 +18,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -r dev_requirements/requirements-formatting.txt
+          pip install .[formatting]
       - name: ${{ matrix.tool }} Code Formatter
         run: |
           ${{ matrix.tool }} . --check
diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml
@@ -52,7 +52,7 @@ jobs:
        - name: Install dependencies
          run: |
            python -m pip install --upgrade pip
-           pip install -r dev_requirements/requirements-test_packaging.txt
+           pip install .[test_packaging]
        - name: Build wheel and source distributions
          run: |
            python -m build

diff --git a/README.rst b/README.rst
@@ -129,8 +129,8 @@ Functionality
    ``unknown``.
 -  Brackets e.g. ``([43]O[4])U[5]``
 -  Requirement indicators (i.e ``Muss``, ``Soll``, ``Kann``, ``X``,
-   ``O``, ``U``) are seperated from the condition expressions and also
-   seperated into single requirement indicator expressions if there are
+   ``O``, ``U``) are separated from the condition expressions and also
+   separated into single requirement indicator expressions if there are
    more than one (for modal marks).
 -  ``Format Constraint Expressions`` that are returned after the
    requirement condition evaluation can now be parsed and evaluated.
@@ -309,13 +309,13 @@ Unknown Neutral Unknown
 |         |         |                     | of hint and format    |
 |         |         |                     | constraint            |
 +---------+---------+---------------------+-----------------------+
-| Unkown  | True    | Unknown             |                       |
+| Unknown | True    | Unknown             |                       |
 +---------+---------+---------------------+-----------------------+
-| Unkown  | False   | Unknown             |                       |
+| Unknown | False   | Unknown             |                       |
 +---------+---------+---------------------+-----------------------+
-| Unkown  | Unknown | Unknown             |                       |
+| Unknown | Unknown | Unknown             |                       |
 +---------+---------+---------------------+-----------------------+
-| Unkown  | Neutral | does not make sense |                       |
+| Unknown | Neutral | does not make sense |                       |
 +---------+---------+---------------------+-----------------------+
 
 Link to automatically generate HintsProvider Json content:
@@ -361,7 +361,7 @@ UTILMD could be a scope. If a condition is described as
    There has to be exactly one xyz per Vorgang (SG4+IDE) Then for ``n``
    Vorgänge there are ``n`` scopes:
 
--  one scope for each Vorgang (pathes refer to an edifact seed):
+-  one scope for each Vorgang (path's refer to an edifact seed):
 
    -  ``$["Dokument"][0]["Nachricht"][0]["Vorgang"][0]``
    -  ``$["Dokument"][0]["Nachricht"][0]["Vorgang"][1]``

diff --git a/dev_requirements/requirements-coverage.in b/dev_requirements/requirements-coverage.in
diff --git a/dev_requirements/requirements-coverage.txt b/dev_requirements/requirements-coverage.txt
diff --git a/dev_requirements/requirements-formatting.in b/dev_requirements/requirements-formatting.in
diff --git a/dev_requirements/requirements-formatting.txt b/dev_requirements/requirements-formatting.txt
diff --git a/dev_requirements/requirements-json_schemas.in b/dev_requirements/requirements-json_schemas.in
diff --git a/dev_requirements/requirements-json_schemas.txt b/dev_requirements/requirements-json_schemas.txt
diff --git a/dev_requirements/requirements-linting.in b/dev_requirements/requirements-linting.in
diff --git a/dev_requirements/requirements-linting.txt b/dev_requirements/requirements-linting.txt
diff --git a/dev_requirements/requirements-test_packaging.in b/dev_requirements/requirements-test_packaging.in
diff --git a/dev_requirements/requirements-test_packaging.txt b/dev_requirements/requirements-test_packaging.txt
diff --git a/dev_requirements/requirements-tests.in b/dev_requirements/requirements-tests.in
diff --git a/dev_requirements/requirements-tests.txt b/dev_requirements/requirements-tests.txt
diff --git a/dev_requirements/requirements-type_check.in b/dev_requirements/requirements-type_check.in
diff --git a/dev_requirements/requirements-type_check.txt b/dev_requirements/requirements-type_check.txt
diff --git a/docs/conf.py b/docs/conf.py
@@ -31,6 +31,8 @@
 # This hack is necessary since RTD does not issue `sphinx-apidoc` before running
 # `sphinx-build -b html . _build/html`. See Issue:
 # https://github.com/rtfd/readthedocs.org/issues/1139
+# DON'T FORGET: Check the box "Install your project inside a virtualenv using
+# pyproject.toml install" in the RTD Advanced Settings.
 # Additionally, it helps us to avoid running apidoc manually
 
 try:  # for Sphinx >= 1.7
@@ -102,9 +104,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = ""
+version = ""  # Is set by calling `pyproject.toml docs`
 # The full version, including alpha/beta/rc tags.
-release = ""
+release = ""  # Is set by calling `pyproject.toml docs`
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/domain-specific-terms.txt b/domain-specific-terms.txt
@@ -0,0 +1,9 @@
+# contains 1 lower case word per line which are ignored in the spell_check
+Dokument
+ist
+oder
+CONTRL
+oll
+BU
+adresse
+alle