Modified: Split requirements.txt into prod, dev and docs.

.github/workflows/CI.yml

@@ -11,7 +11,9 @@ jobs:
         with:
           python-version: '3.8'
       - name: Install dependencies
-        run: pip install -r requirements.txt
+        run: pip install -r requirements_prod.txt
+      - name: Install pytest and pytest-cov
+        run: pip install pytest pytest-cov
       - name: Run tests and collect coverage
         run: pytest --cov mloptimizer
       - name: Upload coverage to Codecov

.github/workflows/code_quality.yml

@@ -25,7 +25,7 @@ jobs:
         with:
           python-version: '3.8'
       - name: Install dependencies
-        run: pip install -r requirements.txt
+        run: pip install -r requirements_dev.txt
       - name: 'Qodana Scan'
         uses: JetBrains/[email protected]
         env:

.readthedocs.yaml

@@ -13,7 +13,7 @@ sphinx:
 python:
   # Install our python package before building the docs
   install:
-    - requirements: requirements.txt
+    - requirements: requirements_docs.txt
 
 formats:
   - pdf

Dockerfile

@@ -4,5 +4,5 @@ WORKDIR /mloptimizer
 
 # By copying over requirements first, we make sure that Docker will cache
 # our installed requirements rather than reinstall them on every build
-COPY requirements.txt /mloptimizer/requirements.txt
-RUN pip install -r requirements.txt
+COPY requirements_prod.txt /mloptimizer/requirements_prod.txt
+RUN pip install -r requirements_prod.txt

docs/conf.py

@@ -12,9 +12,9 @@
 sys.path.insert(0, os.path.abspath('..'))
 
 project = 'mloptimizer'
-copyright = '2023, Antonio Caparrini'
+copyright = '2024, Antonio Caparrini'
 author = 'Antonio Caparrini'
-release = '0.6.0'
+release = '0.6.1'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

requirements_docs.txt

@@ -0,0 +1,20 @@
+catboost>=1.1.1
+deap>=1.3.3
+joblib>=1.2.0
+keras==2.12.0
+pandas>=1.5.3
+python-dateutil>=2.8.1
+pytz>=2022.7.1
+scikit-learn>=1.2.1
+scipy>=1.10.0
+seaborn==0.12.2
+six>=1.15.0
+tensorflow>=2.12.0
+xgboost>=1.7.3
+plotly>=5.15.0
+pytest-cov
+kaleido
+sphinx-gallery==0.14.0
+sphinx_book_theme
+sphinx_mdinclude
+sphinx-autoapi

requirements_prod.txt

@@ -0,0 +1,15 @@
+catboost>=1.1.1
+deap>=1.3.3
+joblib>=1.2.0
+keras==2.12.0
+pandas>=1.5.3
+python-dateutil>=2.8.1
+pytz>=2022.7.1
+scikit-learn>=1.2.1
+scipy>=1.10.0
+seaborn==0.12.2
+six>=1.15.0
+tensorflow>=2.12.0
+xgboost>=1.7.3
+plotly>=5.15.0
+kaleido

setup.py

@@ -5,6 +5,12 @@
 here = pathlib.Path(__file__).parent.resolve()
 long_description = (here / "README.md").read_text(encoding="utf-8")
 
+
+def read_requirements(requirements_file):
+    with open(requirements_file) as f:
+        return f.read().splitlines()
+
+
 setup(
     # This is the name of your project. The first time you publish this
     # package, this name will be registered for you. It will determine how
@@ -24,7 +30,7 @@
     # For a discussion on single-sourcing the version across setup.py and the
     # project code, see
     # https://packaging.python.org/guides/single-sourcing-package-version/
-    version="0.6.0",  # Required
+    version="0.6.1",  # Required
     # This is a one-line description or tagline of what your project does. This
     # corresponds to the "Summary" metadata field:
     # https://packaging.python.org/specifications/core-metadata/#summary
@@ -111,29 +117,8 @@
     #
     # For an analysis of "install_requires" vs pip's requirements files see:
     # https://packaging.python.org/discussions/install-requires-vs-requirements/
-    install_requires=[
-        "catboost>=1.1.1",
-        "deap>=1.3.3",
-        "joblib>=1.2.0",
-        "keras==2.12.0",
-        # "numpy>=1.24.1",
-        "pandas>=1.5.3",
-        "python-dateutil>=2.8.1",
-        "pytz>=2022.7.1",
-        "scikit-learn>=1.2.1",
-        "scipy>=1.10.0",
-        "seaborn==0.12.2",
-        "six>=1.15.0",
-        "tensorflow>=2.12.0",
-        "xgboost>=1.7.3",
-        # "matplotlib~=3.7.1",
-        "plotly>=5.15.0",
-        "sphinx-gallery==0.14.0",
-        "sphinx_book_theme",
-        "kaleido",
-        "sphinx_mdinclude",
-        "sphinx-autoapi"
-    ],  # Optional
+    install_requires=read_requirements("requirements_prod.txt"),
+    # Optional
     # List additional groups of dependencies here (e.g. development
     # dependencies). Users will be able to install these using the "extras"
     # syntax, for example:
@@ -142,10 +127,10 @@
     #
     # Similar to `install_requires` above, these must be valid existing
     # projects.
-    # extras_require={  # Optional
-    #    "dev": ["check-manifest"],
-    #    "test": ["coverage"],
-    # },
+    extras_require={  # Optional
+        "dev": read_requirements("requirements_dev.txt"),
+        "docs": read_requirements("requirements_docs.txt"),
+    },
     # If there are data files included in your packages that need to be
     # installed, specify them here.
     # package_data={  # Optional