Merge pull request #3 from valentingol/badges

✨ Add pytest/pylint actions and their badges

Author: valentingol

.coveragerc

@@ -0,0 +1,3 @@
+[report]
+exclude_lines =
+    if TYPE_CHECKING:

.github/workflows/.pylint.yaml

@@ -0,0 +1,52 @@
+name: Pylint
+
+on: [push]
+
+jobs:
+  pylint-lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.9
+      - name: Cache installation
+        uses: actions/cache@v1
+        id: cache
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+      - name: Install
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements-dev.txt
+          pip install pylint pylint-django
+          pip install -e .
+      - name: Analysing the code with pylint
+        run: |
+          pylint --rcfile=.pylintrc --output-format=text $(git ls-files '*.py') | tee .pylint.txt
+      - name: Handle pylint results
+        run: |
+          score=$(sed -n 's/^Your code has been rated at \([-0-9.]*\)\/.*/\1/p' .pylint.txt)
+          echo "Pylint score was $score"
+          color=$(python3 -m github_actions_utils.pylint_manager --score=$score)
+          echo "PYLINT_COLOR=$color"
+          echo "PYLINT_COLOR=$color" >> $GITHUB_ENV
+          echo "PYLINT_SCORE=$score/10.00"
+          echo "PYLINT_SCORE=$score/10.00" >> $GITHUB_ENV
+      - name: Create Pylint Badge
+        uses: schneegans/dynamic-badges-action@v1.1.0
+        with:
+          auth: ${{ secrets.GIST_SECRET }}
+          gistID: 8fb4f3f78584e085dd7b0cca7e046d1f
+          filename: torch_pca_pylint.json
+          label: Pylint
+          message: ${{ env.PYLINT_SCORE }}
+          color: ${{ env.PYLINT_COLOR }}
+          style: flat
+          namedLogo: stylelint
+          logoColor: "#959DA5"
+          labelColor: "#343B42"

.github/workflows/pypi_deployment.yaml

@@ -0,0 +1,30 @@
+name: PyPi
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v1
+        with:
+          python-version: "3.x"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+      - name: Build
+        run: |
+          python -m build
+      - name: Publish
+        env:
+          TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        run: |
+          twine upload dist/*

.github/workflows/tests.yaml

@@ -0,0 +1,55 @@
+name: Tests
+
+on: [push]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out source repository
+        uses: actions/checkout@v2
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.9
+      - name: Cache installation
+        uses: actions/cache@v1
+        id: cache
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+      - name: Install
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements-dev.txt
+          pip install pytest pytest-cov
+          pip install -e .
+      - name: Test with pytest
+        run: |
+          pytest --disable-pytest-warnings --cov-report=term --cov=src --cov-config=.coveragerc tests/ | tee .pytest.txt
+      - name: Handle test results
+        run: |
+          score=$(cat .pytest.txt | grep TOTAL | tr -s ' ' | cut -d ' ' -f 4)
+          n_failures=$(cat .pytest.txt | grep failed | cut -d ' ' -f 2)
+          echo "Pytest finds $n_failures failure(s)"
+          echo "Tests coverage is $score"
+          color=$(python3 -m github_actions_utils.pytest_manager --score=$score --n_failures=$n_failures)
+          echo "PYTEST_COLOR=$color"
+          echo "PYTEST_COLOR=$color" >> $GITHUB_ENV
+          echo "PYTEST_SCORE=$score"
+          echo "PYTEST_SCORE=$score" >> $GITHUB_ENV
+      - name: Create Coverage Badge
+        uses: schneegans/dynamic-badges-action@v1.1.0
+        with:
+          auth: ${{ secrets.GIST_SECRET }}
+          gistID: c5a6b5731db93da673f8e258b2669080
+          filename: torch_pca_tests.json
+          label: Coverage
+          message: ${{ env.PYTEST_SCORE }}
+          color: ${{ env.PYTEST_COLOR }}
+          style: flat
+          namedLogo: codecov
+          logoColor: "#959DA5"
+          labelColor: "#343B42"