Project: split dev and test dependencies (#213)

.github/workflows/lint-and-tests.yml

@@ -40,6 +40,7 @@ jobs:
           python -m pip install --upgrade pip setuptools wheel
           python -m pip install --upgrade -r requirements.txt
           python -m pip install --upgrade -r requirements/development.txt
+          python -m pip install --upgrade -r requirements/testing.txt
 
       - name: Lint with flake8
         run: |

README.md

@@ -67,7 +67,7 @@ Following initiative from the author of Material for MkDocs, this plugin provide
 
 Clone the repository:
 
-```bash
+```sh
 # install development dependencies
 python -m pip install -U -r requirements/development.txt
 # alternatively: pip install -e .[dev]
@@ -77,18 +77,33 @@ python -m pip install -e .
 
 # install git hooks
 pre-commit install
+```
+
+Then follow the [contribution guidelines](CONTRIBUTING.md).
+
+### Run the tests
+
+```sh
+# install development dependencies
+python -m pip install -U -r requirements/testing.txt
+# alternatively: pip install -e .[test]
 
 # run tests
 pytest
+```
+
+### Build the documentation
 
+```sh
 # install dependencies for documentation
 python -m pip install -U -r requirements/documentation.txt
 # alternatively: pip install -e .[doc]
-```
 
-Then follow the [contribution guidelines](CONTRIBUTING.md).
+# build the documentation
+mkdocs build
+```
 
-## Release workflow
+### Release workflow
 
 1. Fill the `CHANGELOG.md`
 1. Change the version number in `__about__.py`

requirements/development.txt

@@ -3,8 +3,9 @@
 # Development
 # -----------------------
 black
-feedparser>=6.0,<6.1
-flake8>=4,<7
+flake8>=6,<7
+flake8-bugbear>=23.12
+flake8-builtins>=2.1
+flake8-eradicate>=1
+flake8-isort>=6
 pre-commit>=3,<4
-pytest-cov>=4,<4.2
-validator-collection>=1.5,<1.6

requirements/testing.txt

@@ -0,0 +1,9 @@
+-r base.txt
+
+# Testing
+# -------
+
+feedparser>=6.0,<6.1
+mkdocs-material>=9
+pytest-cov>=4,<4.2
+validator-collection>=1.5,<1.6

setup.py

@@ -5,7 +5,8 @@
 # ##################################
 
 # standard library
-import pathlib
+from pathlib import Path
+from typing import List, Union
 
 # 3rd party
 from setuptools import find_packages, setup
@@ -17,30 +18,40 @@
 # ########## Globals #############
 # ################################
 
-HERE = pathlib.Path(__file__).parent
+HERE = Path(__file__).parent
 README = (HERE / "README.md").read_text()
 
-with open(HERE / "requirements/base.txt") as f:
-    requirements = [
-        line
-        for line in f.read().splitlines()
-        if not line.startswith(("#", "-")) and len(line)
-    ]
+# ############################################################################
+# ########### Functions ############
+# ##################################
+
+
+def load_requirements(requirements_files: Union[Path, List[Path]]) -> list:
+    """Helper to load requirements list from a path or a list of paths.
+
+    Args:
+        requirements_files (Path | list[Path]): path or list to paths of requirements
+            file(s)
+
+    Returns:
+        list: list of requirements loaded from file(s)
+    """
+    out_requirements = []
 
-with open(HERE / "requirements/development.txt") as f:
-    requirements_dev = [
-        line
-        for line in f.read().splitlines()
-        if not line.startswith(("#", "-")) and len(line)
-    ]
+    if isinstance(requirements_files, Path):
+        requirements_files = [
+            requirements_files,
+        ]
 
+    for requirements_file in requirements_files:
+        with requirements_file.open(encoding="UTF-8") as f:
+            out_requirements += [
+                line
+                for line in f.read().splitlines()
+                if not line.startswith(("#", "-")) and len(line)
+            ]
 
-with open(HERE / "requirements/documentation.txt") as f:
-    requirements_docs = [
-        line
-        for line in f.read().splitlines()
-        if not line.startswith(("#", "-")) and len(line)
-    ]
+    return out_requirements
 
 
 # ############################################################################
@@ -70,10 +81,12 @@
     # dependencies
     python_requires=">=3.8, <4",
     extras_require={
-        "dev": requirements_dev,
-        "doc": requirements_docs,
+        # tooling
+        "dev": load_requirements(HERE / "requirements/development.txt"),
+        "doc": load_requirements(HERE / "requirements/documentation.txt"),
+        "test": load_requirements(HERE / "requirements/testing.txt"),
     },
-    install_requires=requirements,
+    install_requires=load_requirements(HERE / "requirements/base.txt"),
     # metadata
     keywords="mkdocs rss git plugin",
     classifiers=[