V4.0.0

.github/workflows/beta-cicd.yml

@@ -0,0 +1,81 @@
+name: beta-cicd-setup-and-test
+
+on:
+  push:
+    branches:
+      - "v*.0.0-beta.*"
+  pull_request:
+    branches:
+      - "v*.0.0-beta.*"
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repo
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+      - name: Install pre-commit
+        run: pip install pre-commit
+      - name: Run pre-commit
+        run: pre-commit run --all-files
+
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+    steps:
+      - name: Check out repo
+        uses: actions/checkout@v4
+      - name: Free Disk Space (Ubuntu)
+        uses: jlumbroso/free-disk-space@main
+        with:
+          # this might remove tools that are actually needed,
+          # if set to "true" but frees about 6 GB
+          tool-cache: false
+          # all of these default to true, but feel free to set to
+          # "false" if necessary for your workflow
+          android: true
+          dotnet: true
+          haskell: true
+          large-packages: true
+          docker-images: true
+          swap-storage: true
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Tesseract OCR
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y software-properties-common
+          sudo add-apt-repository -y ppa:alex-p/tesseract-ocr-devel
+          sudo apt-get update
+          sudo apt-get install -y tesseract-ocr libtesseract-dev
+          tesseract --version
+          dpkg -l | grep tesseract
+      - name: Verify Tesseract Installation
+        run: |
+          which tesseract
+          tesseract --list-langs
+      - name: Install Dependencies
+        run: |
+          pip install -U pip
+          pip install --no-cache-dir -e .
+          pip install --no-cache-dir tox just pre-commit
+      - name: Free up disk space
+        run: |
+          sudo apt-get clean
+      - name: Run Tests with tox
+        run: tox -- --cov datafog --cov-report xml --cov-report term -v -s --cov-report=term-missing
+      - name: Submit to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ./coverage.xml
+          flags: unittests
+          name: codecov-umbrella

.github/workflows/feature-cicd.yml

@@ -27,7 +27,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.10"]
+        python-version: ["3.10", "3.11", "3.12"]
     steps:
       - name: Check out repo
         uses: actions/checkout@v4

.gitignore

@@ -32,4 +32,8 @@ node_modules/
 .DS_Store
 .venv
 examples/venv/
-error_log.txt
+error_log.txt
+docs/*
+!docs/*.rst
+!docs/conf.py
+scratch.py

.readthedocs.yaml

@@ -0,0 +1,31 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+# python:
+#    install:
+#    - requirements: docs/requirements.txt

CONTRIBUTING.md

@@ -23,3 +23,7 @@ project [license](LICENSE) and affirming that you either own copyright
 (automatic for most individuals) or are authorized to distribute under
 the project license (e.g., in case your employer retains copyright on
 your work).
+
+### Legal Notice
+
+When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.