Start using tox

Use tox for managing different python virtual environments
and running tests. By integrating tox in the CI, the python
environment in the CI is reproducible locally.

Update the README.

Signed-off-by: Teodora Sechkova <[email protected]>

.github/workflows/github-actions-test.yml

@@ -2,24 +2,33 @@ name: test
 on : [pull_request, push]
 jobs:
   mcat-action-test:
-    runs-on: macos-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.7", "3.8", "3.9", "3.10"]
+        os: [ubuntu-latest, macos-latest]
+        toxenv: [py]
+
+    env:
+      # see tox.ini
+      TOXENV: ${{ matrix.toxenv }}
+
+    runs-on: ${{ matrix.os }}
     steps:
       - run: echo "The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
       - name: Checkout repository code
         uses: actions/checkout@v2
 
-      - name: Setup python
+      - name: Setup python ${{ matrix.python-version }}
         uses: actions/setup-python@v2
         with: 
-          python-version: '3.7'
+          python-version: ${{ matrix.python-version }}
           architecture: 'x64'
 
       - name: Install python packages
         run: |
           python -m pip install --upgrade pip
-          pip install -r requirements.txt
+          python -m pip install --upgrade tox
           
-      - name: Test
-        run: |
-          cd ml-conversational-analytic-tool
-          python -m unittest discover -s tests
+      - name: Run tox (${{ env.TOXENV }})
+        run: tox

README.md

@@ -81,6 +81,11 @@ create isolated Python environment is recommended for this project.
    ```python
    python -m unittest tests/<file_name>
    ```
+8. By using tox
+   ```python
+   python -m pip install --upgrade tox
+   tox
+   ```
 
 The libraries used within the project are available in the [requirements.txt](./requirements.txt).
 

tox.ini

@@ -0,0 +1,17 @@
+# tox (https://tox.readthedocs.io/) is a tool for running tests
+# in multiple virtualenvs. This configuration file will run the
+# test suite on all supported python versions. To use it, "pip install tox"
+# and then run "tox" from this directory.
+
+[tox]
+envlist = py
+skipsdist=True
+
+[testenv]
+changedir = 
+    {toxinidir}
+deps =  
+    -r{toxinidir}/requirements.txt
+
+commands =
+    python -m unittest discover -s tests