Use GitHub actions to lint and test (#163)

Author: ianare

.github/workflows/linting.yml

@@ -0,0 +1,43 @@
+#
+# Run static code analysis.
+#
+name: Static Analysis
+
+on:
+  - push
+
+jobs:
+  static-check:
+    name: Run Static Analysis
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8"]
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Cache dependencies
+      uses: actions/cache@v2
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-dev-${{ hashFiles('setup.py') }}
+        restore-keys: |
+          ${{ runner.os }}-dev-
+
+    - name: Install dependencies
+      run: |
+        pip install virtualenv
+        make venv reqs-install
+
+    - name: Analysing the code with mypy
+      run: |
+        make mypy
+
+    - name: Analysing the code with pylint
+      run: |
+        make lint

.github/workflows/test.yml

@@ -0,0 +1,54 @@
+#
+# Run unit tests.
+#
+name: Test
+
+on:
+  - pull_request
+
+jobs:
+  pytest:
+    name: Run Tests
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    strategy:
+      matrix:
+        python-version:
+          - "3.5"
+          - "3.6"
+          - "3.7"
+          - "3.8"
+          - "3.9"
+          - "3.10"
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Cache dependencies
+      uses: actions/cache@v2
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-test-${{ hashFiles('setup.py') }}
+        restore-keys: |
+          ${{ runner.os }}-test-
+
+    - name: Download Samples
+      run: |
+        make samples-download
+
+    - name: Install
+      run: |
+        pip install -e .
+
+    - name: Run in debug and color mode
+      run: |
+        find exif-samples-master -name *.tiff -o -name *.jpg | xargs EXIF.py -dc
+
+    - name: Compare image processing output
+      run: |
+        find exif-samples-master -name *.tiff -o -name *.jpg | sort -f | xargs EXIF.py > exif-samples-master/dump_test
+        diff -Z --side-by-side --suppress-common-lines exif-samples-master/dump exif-samples-master/dump_test

.pylintrc

@@ -60,79 +60,13 @@ confidence=
 # --enable=similarities". If you want to run only the classes checker, but have
 # no Warning level messages displayed, use "--disable=all --enable=classes
 # --disable=W".
-disable=parameter-unpacking,
-        unpacking-in-except,
-        backtick,
-        long-suffix,
-        raw-checker-failed,
-        bad-inline-option,
-        locally-disabled,
-        file-ignored,
-        suppressed-message,
-        useless-suppression,
-        use-symbolic-message-instead,
-        apply-builtin,
-        basestring-builtin,
-        buffer-builtin,
-        cmp-builtin,
-        coerce-builtin,
-        execfile-builtin,
-        file-builtin,
-        long-builtin,
-        raw_input-builtin,
-        reduce-builtin,
-        standarderror-builtin,
-        unicode-builtin,
-        xrange-builtin,
-        coerce-method,
-        delslice-method,
-        getslice-method,
-        setslice-method,
-        no-absolute-import,
-        old-division,
-        dict-iter-method,
-        dict-view-method,
-        next-method-called,
-        metaclass-assignment,
-        indexing-exception,
-        oct-method,
-        hex-method,
-        nonzero-method,
-        cmp-method,
-        input-builtin,
-        round-builtin,
-        intern-builtin,
-        unichr-builtin,
-        map-builtin-not-iterating,
-        zip-builtin-not-iterating,
-        range-builtin-not-iterating,
-        filter-builtin-not-iterating,
-        using-cmp-argument,
-        eq-without-hash,
-        div-method,
-        idiv-method,
-        rdiv-method,
-        exception-message-attribute,
-        deprecated-str-translate-call,
-        deprecated-itertools-function,
-        deprecated-types-field,
-        next-method-defined,
-        dict-items-not-iterating,
-        dict-keys-not-iterating,
-        dict-values-not-iterating,
-        deprecated-operator-function,
-        xreadlines-attribute,
-        deprecated-sys-function,
-        exception-escape,
-        comprehension-escape,
-        missing-docstring,
-        # some magic stuff going on, look into this
-        import-error,
+disable=missing-docstring,
+        duplicate-code,  # https://github.com/PyCQA/pylint/issues/214
         # we should try to get rid of these at some point!
         fixme,
+        consider-using-f-string,
         too-many-arguments,
         too-many-branches,
-        too-many-statements,
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option

.travis.yml

@@ -6,7 +6,7 @@
 #
 #
 # Copyright (c) 2002-2007 Gene Cash
-# Copyright (c) 2007-2020 Ianaré Sévi and contributors
+# Copyright (c) 2007-2022 Ianaré Sévi and contributors
 #
 # See LICENSE.txt file for licensing information
 # See ChangeLog.rst file for all contributors and changes
@@ -18,9 +18,8 @@
 
 import sys
 import argparse
-import logging
 import timeit
-from exifread.tags import DEFAULT_STOP_TAG, FIELD_TYPES
+from exifread.tags import FIELD_TYPES
 from exifread import process_file, exif_log, __version__
 
 logger = exif_log.get_logger()
@@ -122,5 +121,4 @@ def main(args) -> None:
 
 
 if __name__ == '__main__':
-    args = get_args()
-    main(args)
+    main(get_args())

EXIF.py

@@ -24,15 +24,15 @@ lint: ## Run linting (pylint)
 	$(PYLINT_BIN) -f colorized ./exifread
 
 mypy: ## Run mypy
-	$(MYPY_BIN) --show-error-context ./exifread
+	$(MYPY_BIN) --show-error-context ./exifread ./EXIF.py
 
 #test: ## Run all tests
 #	$(PYTHON_BIN) -m unittest discover -v -s ./tests
 
 analyze: lint mypy ## Run all static analysis tools
 
-reqs-install: ## Install requirements
-	$(PIP_INSTALL) pylint==2.6.2 mypy==0.782
+reqs-install: ## Install with all requirements
+	$(PIP_INSTALL) .[dev]
 
 samples-download: ## Install sample files used for testing.
 	wget https://github.com/ianare/exif-samples/archive/master.tar.gz

Makefile

@@ -13,12 +13,7 @@ Supported formats: TIFF, JPEG, Webp, HEIC
 Compatibility
 *************
 
-EXIF.py is tested and officially supported on the following Python versions:
-
-- 3.5
-- 3.6
-- 3.7
-- 3.8
+EXIF.py is tested and officially supported on Python 3.5 to 3.10
 
 Starting with version ``3.0.0``, Python2 compatibility is dropped *completely*
 (syntax errors due to type hinting).
@@ -29,21 +24,23 @@ https://pythonclock.org/
 Installation
 ************
 
-PyPI
-====
+Stable Version
+==============
 The recommended process is to install the `PyPI package <https://pypi.python.org/pypi/ExifRead>`_,
 as it allows easily staying up to date::
 
     $ pip install exifread
 
 See the `pip documentation <https://pip.pypa.io/en/latest/user_guide.html>`_ for more info.
 
-Archive
-=======
-Download an archive from the project's `releases page <https://github.com/ianare/exif-py/releases>`_.
+Development Version
+===================
+
+After cloning the repo, use the provided Makefile::
 
-Extract and enjoy.
+  make venv reqs-install
 
+Which will install a virtual environment and install development dependencies.
 
 Usage
 *****
@@ -53,13 +50,13 @@ Command line
 
 Some examples::
 
-    $ EXIF.py image1.jpg
-    $ EXIF.py -dc image1.jpg image2.tiff
-    $ find ~/Pictures -name "*.jpg" -o -name "*.tiff" | xargs EXIF.py
+    EXIF.py image1.jpg
+    EXIF.py -dc image1.jpg image2.tiff
+    find ~/Pictures -name "*.jpg" -o -name "*.tiff" | xargs EXIF.py
 
 Show command line options::
 
-    $ EXIF.py -h
+    EXIF.py -h
 
 Python Script
 =============