Set up publishing on PyPI

.github/workflows/publish.yml

@@ -0,0 +1,89 @@
+name: Publish Python distribution 📦 to PyPI and TestPyPI
+
+on: push
+
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.x"
+
+    - name: Install pypa/build
+      run: |
+        python3 -m pip install build --user
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-pypi:
+    name: >-
+      Publish Python distribution 📦 to PyPI
+    if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/ocrmypdf-easyocr  # Replace <package-name> with your PyPI project name
+    permissions:
+      id-token: write
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution 📦 to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    name: >-
+      Sign the Python distribution 📦 with Sigstore
+      and upload them to GitHub Release
+    needs:
+    - publish-to-pypi
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write  # IMPORTANT: mandatory for making GitHub Releases
+      id-token: write  # IMPORTANT: mandatory for sigstore
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Sign the dists with Sigstore
+      uses: sigstore/[email protected]
+      with:
+        inputs: >-
+          ./dist/*.tar.gz
+          ./dist/*.whl
+    - name: Create GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      run: >-
+        gh release create
+        '${{ github.ref_name }}'
+        --repo '${{ github.repository }}'
+        --notes ""
+    - name: Upload artifact signatures to GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      # Upload to GitHub Release using the `gh` CLI.
+      # `dist/` contains the built packages, and the
+      # sigstore-produced signatures and certificates.
+      run: >-
+        gh release upload
+        '${{ github.ref_name }}' dist/**
+        --repo '${{ github.repository }}'

README.md

@@ -23,6 +23,10 @@ pip install git+https://github.com/ocrmypdf/OCRmyPDF-EasyOCR.git
 The OCRmyPDF-EasyOCR will override Tesseract for OCR; however, OCR still depends
 on Tesseract for some tasks.
 
+If [Celery's multiprocessing](https://docs.celeryq.dev/en/stable/getting-started/introduction.html)
+is installed in the virtual environment, it will be used instead of the standard
+Python multiprocessing. This allows paperless-ngx, which uses Celery, to function correctly.
+
 ## Troubleshooting
 
 If you see a log message

pyproject.toml

@@ -4,12 +4,12 @@ version = "0.1.0"
 description = "Plugin to run OCRmyPDF with the EasyOCR engine"
 authors = [{ name = "James R. Barlow", email = "[email protected]" }]
 dependencies = [
-    "easyocr>=1.7.0",
-    "ocrmypdf>=14.2.1",
-    "Pillow>=10.0.1",
-    "opencv-python-headless>=4.8.0.74",
-    "numpy>=1.20",
-    "torch",
+  "easyocr>=1.7.0",
+  "ocrmypdf>=14.2.1",
+  "Pillow>=10.0.1",
+  "opencv-python-headless>=4.8.0.74",
+  "numpy>=1.20",
+  "torch",
 ]
 requires-python = ">=3.10"
 readme = "README.md"
@@ -22,9 +22,11 @@ ocrmypdf = "ocrmypdf_easyocr"
 
 [project.optional-dependencies]
 dev = ["ruff>=0.0.272"]
-test = [
-  "pytest>=6.2.5",
-]
+test = ["pytest>=6.2.5"]
+
+[project.urls]
+Homepage = "https://github.com/ocrmypdf/OCRmyPDF-EasyOCR"
+Repository = "https://github.com/ocrmypdf/OCRmyPDF-EasyOCR.git"
 
 [build-system]
 requires = ["setuptools"]