Provide visibility for an active fork

.github/workflows/lint-and-test.yml

@@ -0,0 +1,81 @@
+name: Lint and Test
+
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-20.04
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [3.6, 3.7, 3.8, 3.9, '3.10', 3.11, 3.12]
+
+    env:
+      exiftool_version: 12.15
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+        # while https://github.com/actions/setup-python recommends using a specific dependency version to use cache
+        # we'll see if this just uses it in default configuration
+        # this can't be enabled unless a requirements.txt file exists.  PyExifTool doesn't have any hard requirements
+        #cache: 'pip'
+    - name: Cache Perl ExifTool Download
+      # https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows
+      uses: actions/cache@v2
+      env:
+        cache-name: cache-perl-exiftool
+      with:
+        # path where we would extract the ExifTool source files
+        path: Image-ExifTool-${{ env.exiftool_version }}
+        key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ env.exiftool_version }}
+
+    - name: Install dependencies
+      run: |
+        # don't have to do this on the GitHub runner, it's going to always be the latest
+        #python -m pip install --upgrade pip
+        # the setup-python uses it this way instead of calling it via module, so maybe this will cache ...
+        pip install flake8 pytest
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+
+        # latest version not yet available on Ubuntu Focal 20.04 LTS, but it's better to install it with all dependencies first
+        sudo apt-get install -qq libimage-exiftool-perl
+        # print this in the log
+        exiftool -ver
+
+        # get just the minimum version to build and compile, later we can go with latest version to test
+        # working with cache: only get if the directory doesn't exist
+        if [ ! -d Image-ExifTool-${{ env.exiftool_version }} ]; then wget http://backpan.perl.org/authors/id/E/EX/EXIFTOOL/Image-ExifTool-${{ env.exiftool_version }}.tar.gz; fi
+        # extract if it was downloaded
+        if [ -f Image-ExifTool-${{ env.exiftool_version }}.tar.gz ]; then tar xf Image-ExifTool-${{ env.exiftool_version }}.tar.gz; fi
+
+        cd Image-ExifTool-${{ env.exiftool_version }}/
+
+        # https://exiftool.org/install.html#Unix
+        perl Makefile.PL
+        make test
+
+        export PATH=`pwd`:$PATH
+        cd ..
+        exiftool -ver
+
+        # save this environment for subsequent steps
+        # https://brandur.org/fragments/github-actions-env-vars-in-env-vars
+        echo "PATH=`pwd`:$PATH" >> $GITHUB_ENV
+    - name: Install pyexiftool
+      run: |
+        # install all supported json processors for tests
+        python -m pip install .[json,test]
+    - 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
+        # 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
+    - name: Test with pytest
+      run: |
+        pytest

.gitignore

@@ -3,3 +3,14 @@ __pycache__/
 build/
 dist/
 MANIFEST
+
+*.egg-info/
+
+# pytest-cov db
+.coverage
+
+# tests will be made to write to temp directories with this prefix
+tests/exiftool-tmp-*
+
+# IntelliJ
+.idea

COMPATIBILITY.txt

@@ -0,0 +1,55 @@
+PyExifTool does not guarantee source-level compatibility from one release to the next.
+
+That said, efforts will be made to provide well-documented API-level compatibility,
+and if there are major API changes, migration documentation will be provided, when
+possible.
+
+----
+
+v0.1.x - v0.2.0  = smarnach code, API compatible
+v0.2.1 - v0.4.13 = original v0.2 code with all PRs, a superset of functionality on Exiftool class
+v0.5.0 -         = not API compatible with the v0.4.x series.  Broke down functionality stability by classes.  See comments below:
+
+
+----
+API changes between v0.4.x and v0.5.0:
+
+	PYTHON CHANGE: Old: Python 2.6 supported.  New: Python 3.6+ required
+
+	CHANGED: Exiftool constructor:
+		RENAME:   "executable_" parameter to "executable"
+		DEFAULT BEHAVIOR: "common_args" defaults to ["-G", "-n"] instead of None.  Old behavior set -G and -n if "common_args" is None.  New behavior "common_args" = [] if common_args is None.
+		DEFAULT: Old: "win_shell" defaults to True.  New: "win_shell" defaults to False.
+		NEW: "encoding" parameter
+		NEW: "logger" parameter
+
+	NEW PROPERTY GET/SET: a lot of properties were added to do get/set validation, and parameters can be changed outside of the constructor.
+
+	METHOD RENAME: starting the process was renamed from "start" to "run"
+
+	MINIMUM TOOL VERSION: exiftool command line utility minimum requirements.  Old: 8.60.  New: 12.15
+
+	ENCODING CHANGE: execute() and execute_json() no longer take bytes, but is guided by the encoding set in constructor/property
+
+	ERROR CHANGE: execute_json() when no json was not returned (such as a set metadata operation) => Old: raised an error.  New: returns custom ExifToolException
+
+	FEATURE REMOVAL: execute_json() no longer detects the '-w' flag being passed used in common_args.
+		If a user uses this flag, expect no output.
+		(detection in common_args was clunky anyways because -w can be passed as a per-run param for the same effect)
+
+
+	all methods other than execute() and execute_json() moved to ExifToolHelper or ExifToolAlpha class.
+
+	ExifToolHelper adds methods:
+		get_metadata()
+		get_tags()
+
+		NEW CONVENTION: all methods take "files" first, "tags" second (if needed) and "params" last
+
+
+	ExifToolAlpha adds all remaining methods in an alpha-quality way
+
+	NOTE: ExifToolAlpha has not been updated yet to use the new convention, and the edge case code may be removed/changed at any time.
+		If you depend on functionality provided by ExifToolAlpha, please submit an Issue to start a discussion on cleaning up the code and moving it into ExifToolHelper
+----
+

COPYING.BSD

@@ -1,4 +1,4 @@
-Copyright 2012 Sven Marnach
+Copyright 2012 Sven Marnach, 2019-2023 Kevin M (sylikc)
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

LICENSE

@@ -0,0 +1,15 @@
+PyExifTool <http://github.com/sylikc/pyexiftool>
+
+Copyright 2019-2023 Kevin M (sylikc)
+Copyright 2012-2014 Sven Marnach
+
+PyExifTool is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the licence, or
+(at your option) any later version, or the BSD licence.
+
+PyExifTool is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+
+See COPYING.GPL or COPYING.BSD for more details.