FIX #57 - Move requirements files as extra-requires to make install easier

Author: Galileo-Galilei

.github/workflows/test.yml

@@ -25,20 +25,21 @@ jobs:
       uses: actions/setup-python@v1
       with:
         python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
+    - name: Install package
       run: |
         python -m pip install --upgrade pip
-        pip install -r requirements/requirements.txt
-        pip install -r requirements/test_requirements.txt
+        pip install .
+    - name: Install test dependencies
+      run: |
+        pip install kedro-mlflow[tests]
     - name: Lint with flake8
       run: |
         # stop the build if there are Python syntax errors or undefined names
         flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics --exclude kedro_mlflow/template/project/run.py
         # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics --exclude kedro_mlflow/template/project/run.py
+        flake8 . --count --max-complexity=10 --max-line-length=127 --statistics --exclude kedro_mlflow/template/project/run.py
     - name: Test with pytest and generate coverage report
       run: |
-        pip install -e .  # required for some tests which launches commands via subprocess
         pytest --cov=./ --cov-report=xml
     - name: Upload coverage report to Codecov
       uses: codecov/codecov-action@v1

.readthedocs.yml

@@ -18,6 +18,7 @@ formats:
 python:
   version: 3.6
   install:
-    - requirements: requirements/docs_requirements.txt
-    - method: setuptools
+    - method: pip
       path: .
+      extra_requirements:
+       - docs

CONTRIBUTING.md

@@ -2,11 +2,14 @@
 
 The current workflow is the following:
 
-1. Open an issue to describe your feature request or your bug fix with detailed explanation of what you want to achieve.
+1. Open an issue to describe your feature request or your bug fix with a detailed explanation of what you want to achieve.
 2. Fork the repo
 3. Develop locally:
     - Install the precommit file (`pip install pre-commit`, then `pre-commit install`)
     - Create a branch based on the develop branch (``git checkout -b <prefix-branchname> develop``)
+    - Create a conda environment (conda create -n <your-env-name> python==3.7)
+    - Activate this environment (`conda activate <your-env-name>`)
+    - Install the extra dependencies for tests (`pip install kedro-mlflow[tests]`)
     - Apply your changes
     - Run pre-commit (black linting, flake8 errors, isort with ``pre-commit run``)
 4. Submit your changes:
@@ -42,4 +45,4 @@ The current workflow is the following:
 4. Checkout the [publish workflow](https://github.com/Galileo-Galilei/kedro-mlflow/actions?query=workflow%3Apublish) to see if:
     - The package has been uploaded on PyPI sucessfully
     - The changes have been merged back to develop
-5. If the pipeline has failed, please raise an issue to correct the CI, and ensure merge on develop "by hand"".
+5. If the pipeline has failed, please raise an issue to correct the CI, and ensure merge on develop manually.

kedro_mlflow/framework/cli/cli.py

@@ -56,7 +56,7 @@ def commands():
 @commands.command(name="mlflow", cls=KedroClickGroup)
 def mlflow_commands():
     """Use mlflow-specific commands inside kedro project."""
-    pass
+    pass  # pragma: no cover
 
 
 @mlflow_commands.command()

requirements/requirements.txt requirements.txt

@@ -15,8 +15,7 @@ def _parse_requirements(path, encoding="utf-8"):
 
 
 # get the dependencies and installs
-base_requirements = _parse_requirements("requirements/requirements.txt")
-test_requirements = _parse_requirements("requirements/test_requirements.txt")
+base_requirements = _parse_requirements("requirements.txt")
 
 
 # Get the long description from the README file
@@ -36,8 +35,27 @@ def _parse_requirements(path, encoding="utf-8"):
     packages=find_packages(exclude=["docs*", "tests*"]),
     setup_requires=["setuptools_scm"],
     include_package_data=True,
-    tests_require=test_requirements,
     install_requires=base_requirements,
+    extras_require={
+        "docs": [
+            "sphinx==3.4.2",
+            "recommonmark==0.7.1",
+            "sphinx_rtd_theme==0.5.1",
+            "sphinx-markdown-tables==0.0.15",
+            "pandas>=1.0.0, <1.3.0",  # avoid to make readthedocs load rc version
+            "numpy>=1.0.0, <1.19.0",  # bug on windows for numpy 1.19.0->1.19.4
+        ],
+        "tests": [
+            "pytest>=5.4.0, <7.0.0",
+            "pytest-cov>=2.8.0, <3.0.0",
+            "pytest-lazy-fixture>=0.6.0, <1.0.0",
+            "pytest-mock>=3.1.0, <4.0.0",
+            "scikit-learn>=0.23.0, <0.25.0",
+            "flake8==3.8.4",  # ensure consistency with pre-commit
+            "black==20.8b1",  # pin black version because it is not compatible with a pip range (because of non semver version number)
+            "isort==5.7.0",  # ensure consistency with pre-commit
+        ],
+    },
     author="Galileo-Galilei",
     entry_points={
         "kedro.project_commands": [

requirements/docs_requirements.txt

@@ -5,7 +5,6 @@
 
 from kedro_mlflow.utils import (
     KEDRO_VERSION,
-    KedroContextError,
     _already_updated,
     _get_project_globals,
     _is_kedro_project,