tests: remove tox (#226)

- dev: removed pre-commit
- tests: added PyPy 3.9

Author: BoboTiG

.github/dependabot.yml

@@ -0,0 +1,20 @@
+version: 2
+updates:
+  # GitHub Actions
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: daily
+    labels:
+      - dependencies
+      - QA/CI
+
+  # Python requirements
+  - package-ecosystem: pip
+    directory: /
+    schedule:
+      interval: daily
+    assignees:
+      - BoboTiG
+    labels:
+      - dependencies

.github/workflows/tests.yml

@@ -11,74 +11,84 @@ on:
       - "mss/**"
 
 jobs:
-  lint:
-    name: Code quality checks
+  quality:
+    name: Quality
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-        with:
-          ref: ${{ github.event.inputs.branch }}
-      - uses: actions/setup-python@v4
-        with:
-          python-version: "3.x"
-      - name: Install test dependencies
-        run: python -m pip install -U pip wheel tox
-      - name: Tests
-        run: python -m tox -e lint
-
-  types:
-    name: Types checks
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          ref: ${{ github.event.inputs.branch }}
       - uses: actions/setup-python@v4
         with:
           python-version: "3.x"
-      - name: Install test dependencies
-        run: python -m pip install -U pip wheel tox
+          cache: pip
+          cache-dependency-path: dev-requirements.txt
+      - name: Install dependencies
+        run: |
+          python -m pip install -U pip wheel 
+          python -m pip install -r dev-requirements.txt
       - name: Tests
-        run: python -m tox -e types
+        run: ./check.sh
 
   documentation:
-    name: Documentation build
+    name: Documentation
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-        with:
-          ref: ${{ github.event.inputs.branch }}
       - uses: actions/setup-python@v4
         with:
           python-version: "3.x"
+          cache: pip
+          cache-dependency-path: dev-requirements.txt
       - name: Install test dependencies
-        run: python -m pip install -U pip wheel tox
+        run: |
+          python -m pip install -U pip wheel 
+          python -m pip install -r dev-requirements.txt
       - name: Tests
-        run: python -m tox -e docs
+        run: |
+          sphinx-build -d docs docs/source docs_out --color -W -bhtml
 
   tests:
-    name: "${{ matrix.os }} for ${{ matrix.python }}"
-    runs-on: ${{ matrix.os }}
+    name: "${{ matrix.os.emoji }} ${{ matrix.python.name }}"
+    runs-on: ${{ matrix.os.runs-on }}
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
-        python: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+        os:
+          - emoji: 🐧
+            runs-on: [ubuntu-latest]
+          - emoji: 🍎
+            runs-on: [macos-latest]
+          - emoji: 🪟
+            runs-on: [windows-latest]
+        python:
+          - name: CPython 3.7
+            runs-on: "3.7"
+          - name: CPython 3.8
+            runs-on: "3.8"
+          - name: CPython 3.9
+            runs-on: "3.9"
+          - name: CPython 3.10
+            runs-on: "3.10"
+          - name: CPython 3.11
+            runs-on: "3.11"
+          - name: PyPy 3.9
+            runs-on: "pypy-3.9"
     steps:
       - uses: actions/checkout@v3
-        with:
-          ref: ${{ github.event.inputs.branch }}
       - uses: actions/setup-python@v4
         with:
-          python-version: ${{ matrix.python }}
+          python-version: ${{ matrix.python.runs-on }}
+          cache: pip
+          cache-dependency-path: dev-requirements.txt
       - name: Install test dependencies
-        run: python -m pip install -U pip wheel tox
+        run: |
+          python -m pip install -U pip wheel 
+          python -m pip install -r dev-requirements.txt
       - name: Tests on GNU/Linux
-        if: matrix.os == 'ubuntu-latest'
+        if: matrix.os.emoji == '🐧'
         run: |
           export DISPLAY=:99
-          sudo Xvfb -ac ${DISPLAY} -screen 0 1280x1024x24 > /dev/null 2>&1 &
-          python -m tox -e py
+          sudo Xvfb -ac :99 -screen 0 1280x1024x24 > /dev/null 2>&1 &
+          python -m pytest
       - name: Tests on other platforms
-        if: matrix.os != 'ubuntu-latest'
-        run: python -m tox -e py
+        if: matrix.os.emoji != '🐧'
+        run: python -m pytest

.gitignore

@@ -1,16 +1,18 @@
 build/
 .cache/
 dist/
+*.doctree
+docs_out/
 *.egg-info/
 .idea/
 .DS_Store
 *.orig
 *.jpg
 *.png
 *.png.old
+*.pickle
 *.pyc
 .pytest_cache
-.tox
 .vscode
 docs/output/
 .mypy_cache/

.pre-commit-config.yaml

@@ -2,6 +2,11 @@ History:
 
 <see Git checking messages for history>
 
+7.0.2   2023/0x/xx
+      - dev: removed pre-commit
+      - tests: removed tox
+      - tests: added PyPy 3.9
+
 7.0.1   2022/10/27
       - fixed the wheel package
       - removed support for Python 3.6

CHANGELOG

@@ -0,0 +1,10 @@
+#!/bin/bash
+#
+# Small script to ensure quality checks pass before submitting a commit/PR.
+#
+python -m isort docs mss
+python -m black docs mss
+python -m flake8 docs mss
+python -m pylint mss
+# "--platform win32" to not fail on ctypes.windll (it does not affect the overall check on other OSes)
+python -m mypy --platform win32 --exclude mss/tests mss docs/source/examples

check.sh

@@ -0,0 +1,15 @@
+-e .
+black
+build
+flake8
+flaky
+pytest
+pytest-cov
+mypy
+numpy; platform_python_implementation != "pypy"
+numpy==1.15.4; platform_python_implementation == "pypy"
+pillow
+pylint
+sphinx
+twine
+wheel

dev-requirements.txt

@@ -11,32 +11,25 @@ Setup
 2. Create you own branch.
 3. Be sure to add/update tests and documentation within your patch.
 
-Additionally, you can install `pre-commit <http://pre-commit.com/>`_ to ensure you are doing things well::
-
-    $ python -m pip install -U --user pre-commit
-    $ pre-commit install
-
 
 Testing
 =======
 
 Dependency
 ----------
 
-You will need `tox <https://pypi.org/project/tox/>`_::
+You will need `pytest <https://pypi.org/project/pytest/>`_::
 
-    $ python -m pip install -U --user tox
+    $ python -m pip install -U pip wheel
+    $ python -m pip install -r dev-requirements.txt
 
 
 How to Test?
 ------------
 
 Launch the test suit::
 
-    $ tox
-
-    # or
-    $ TOXENV=py37 tox
+    $ python -m pytest
 
 This will test MSS and ensure a good code quality.
 
@@ -46,20 +39,12 @@ Code Quality
 
 To ensure the code is always well enough using `flake8 <https://pypi.org/project/flake8/>`_::
 
-    $ TOXENV=lint tox
-
-
-Static Type Checking
-====================
-
-To check type annotation using `mypy <http://mypy-lang.org/>`_::
-
-    $ TOXENV=types tox
+    $ ./check.sh
 
 
 Documentation
 =============
 
 To build the documentation, simply type::
 
-    $ TOXENV=docs tox
+    $ sphinx-build -d docs docs/source docs_out --color -W -bhtml

docs/source/developers.rst

@@ -81,7 +81,7 @@ def main(args: Optional[List[str]] = None) -> int:
         return 1
 
 
-if __name__ == "__main__":
+if __name__ == "__main__":  # pragma: nocover
     import sys
 
     sys.exit(main(sys.argv[1:]))

mss/__main__.py

@@ -12,8 +12,7 @@
 if platform.system().lower() != "linux":
     pytestmark = pytest.mark.skip
 
-# Note: using `--no-isolation` because it doesn't work with `tox`
-INSTALL = "python -m build --no-isolation --sdist --wheel".split()
+INSTALL = "python -m build --sdist --wheel".split()
 CHECK = "twine check dist/*".split()