deepl-haystack 0.2.1__tar.gz → 0.3.0__tar.gz

deepl_haystack-0.3.0/.github/dependabot.yml

@@ -0,0 +1,52 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    groups:
+      all:
+        patterns:
+          - "*"
+    commit-message:
+      prefix: ":arrow_up:"
+
+  - package-ecosystem: "pip"
+    target-branch: "main"
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
+    allow:
+      - dependency-type: "direct"
+        dependency-name: "deepl"
+      - dependency-type: "direct"
+        dependency-name: "haystack-ai"
+    groups:
+      all:
+        patterns:
+          - "*"
+    commit-message:
+      prefix: ":arrow_up:"
+    versioning-strategy: "lockfile-only"
+
+  - package-ecosystem: "pip"
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
+    allow:
+      - dependency-type: "all"
+    ignore:
+      - dependency-name: "deepl"
+      - dependency-name: "haystack-ai"
+    groups:
+      all:
+        patterns:
+          - "*"
+    commit-message:
+      prefix: ":arrow_up:"
+    versioning-strategy: "increase"

deepl_haystack-0.3.0/.github/workflows/bump.yml

@@ -0,0 +1,113 @@
+name: Bump
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version to release'
+        required: true
+        type: choice
+        options:
+          - 'major'
+          - 'minor'
+          - 'patch'
+        default: 'patch'
+
+jobs:
+  create-release-branch:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: 'write'
+      id-token: 'write'
+    steps:
+      - uses: actions/checkout@v5
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+      - name: Bump version
+        id: bump-version
+        run: |
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          make bump-version COMMIT_VERSION=${{ github.event.inputs.version }}
+          NEW_VERSION=v$(uv version --dry-run --short)
+          git tag -d $NEW_VERSION 2> /dev/null
+          echo "::add-mask::$NEW_VERSION"
+          echo "new-version=$NEW_VERSION" >> "$GITHUB_OUTPUT"
+      - name: Push branch
+        uses: ad-m/github-push-action@master
+        with:
+          branch: release/${{ steps.bump-version.outputs.new-version }}
+      - name: Encrypt tag
+        id: encrypt-tag
+        shell: bash
+        run: |
+          NEW_VERSION=${{ steps.bump-version.outputs.new-version }};
+          BINARY_ENCRYPTED_SECRET=$(echo -n "$NEW_VERSION" | openssl enc -e -a -k "password" | base64);
+          echo "encrypted-version=$BINARY_ENCRYPTED_SECRET" >> $GITHUB_OUTPUT
+    outputs:
+      encrypted-version: ${{ steps.encrypt-tag.outputs.encrypted-version }}
+
+  create-pull-request:
+    needs: [create-release-branch]
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: 'write'
+      contents: 'write'
+      id-token: 'write'
+    steps:
+      - name: Decrypt tag
+        id: decrypt-tag
+        shell: bash
+        run: |
+          ENCRYPTED_SECRET=${{ needs.create-release-branch.outputs.encrypted-version }};
+          VERSION=$(echo -n "$ENCRYPTED_SECRET" | base64 --decode | openssl enc -d -a -k "password");
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+      - uses: actions/checkout@v4
+        with:
+          ref: main
+      - name: Reset release branch
+        run: |
+          git fetch origin release/${{ steps.decrypt-tag.outputs.version }}:release/${{ steps.decrypt-tag.outputs.version }}
+          git reset --hard release/${{ steps.decrypt-tag.outputs.version }}
+      - name: Generate token for release bot
+        uses: actions/create-github-app-token@v2
+        id: generate-token
+        with:
+          app-id: ${{ secrets.RELEASE_BOT_APP_ID }}
+          private-key: ${{ secrets.RELEASE_BOT_APP_PRIVATE_KEY }}
+      - name: Create Pull Request
+        id: cpr
+        uses: peter-evans/create-pull-request@v7
+        with:
+          token: ${{ steps.generate-token.outputs.token }}
+          commit-message: ":label: Version bump to ${{ steps.decrypt-tag.outputs.version }}"
+          base: ${{ github.ref_name }}
+          branch: release/${{ steps.decrypt-tag.outputs.version }}-merge
+          delete-branch: true
+          title: ":label: Version bump to ${{ steps.decrypt-tag.outputs.version }}"
+          reviewers: ${{ github.actor }}
+
+  delete-release-branch:
+    if: ${{ ! inputs.keep-release-branch }}
+    needs: [create-release-branch, create-pull-request]
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: 'write'
+      contents: 'write'
+      id-token: 'write'
+    steps:
+      - name: Decrypt tag
+        id: decrypt-tag
+        shell: bash
+        run: |
+          ENCRYPTED_SECRET=${{ needs.create-release-branch.outputs.encrypted-version }};
+          VERSION=$(echo -n "$ENCRYPTED_SECRET" | base64 --decode | openssl enc -d -a -k "password");
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Delete release branch
+        run: |
+          git push origin --delete release/${{ steps.decrypt-tag.outputs.version }}

deepl_haystack-0.3.0/.github/workflows/lint.yml

@@ -0,0 +1,25 @@
+name: Lint
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: [opened, synchronize]
+    branches:
+      - main
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: '3.12'
+          enable-cache: true
+      - name: Install Dependencies
+        run: uv sync --no-default-groups --group ci --group lint
+      - name: Lint
+        run: make lint

deepl_haystack-0.3.0/.github/workflows/publish.yml

@@ -0,0 +1,20 @@
+name: Publish
+
+on:
+  release:
+    types:
+      - published
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+      - name: Build
+        run: uv build --no-sources
+      - name: Publish
+        run: uv publish --token ${{ secrets.POETRY_PYPI_TOKEN_PYPI }}

deepl_haystack-0.3.0/.github/workflows/release.yml

@@ -0,0 +1,30 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  create-release:
+    if: contains(github.event.head_commit.message, 'dribia/release/v') && contains(github.event.head_commit.message, '-merge')
+    runs-on: ubuntu-latest
+    permissions:
+      contents: 'write'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Get release tag
+        id: get-tag
+        run: |
+          TAG=$(echo "${{ github.event.head_commit.message }}" | head -n1 | cut -d"/" -f3 | cut -d"-" -f1);
+          echo "tag=$TAG" >> $GITHUB_OUTPUT
+      - name: Release
+        uses: softprops/action-gh-release@v2
+        with:
+          generate_release_notes: true
+          make_latest: true
+          tag_name: ${{ steps.get-tag.outputs.tag }}
+          draft: true
+    outputs:
+      tag: ${{ steps.get-tag.outputs.tag }}

deepl_haystack-0.3.0/.github/workflows/test.yml

@@ -0,0 +1,57 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: [opened, synchronize]
+    branches:
+      - main
+
+jobs:
+  unit-tests:
+    name: Unit Tests
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+        os: [ubuntu-latest]
+      fail-fast: false
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+          enable-cache: true
+      - name: Install Dependencies
+        run: uv sync --no-default-groups --group ci --group test
+      - name: Test
+        run: make test-unit
+      - uses: codecov/codecov-action@v4
+        with:
+          fail_ci_if_error: true
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+  integration-tests:
+    name: Integration Tests
+    needs: unit-tests
+    strategy:
+      matrix:
+        python-version: [ "3.13" ]
+        os: [ ubuntu-latest ]
+    runs-on: ubuntu-latest
+    env:
+      DEEPL_API_KEY: ${{ secrets.DEEPL_API_KEY }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+          enable-cache: true
+      - name: Install Dependencies
+        run: uv sync --no-default-groups --group ci --group test
+      - name: Test
+        run: make test-integration

deepl_haystack-0.3.0/.gitignore

@@ -0,0 +1,114 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+.static_storage/
+.media/
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/sphinx/build/
+docs/sphinx/source/api/
+docs/sphinx/source/README.rst
+docs/sphinx/source/LICENSE.rst
+docs/sphinx/source/thirdparty.rst
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# pycharm
+.idea/
+
+# sqlite databases files
+data/db/*db

deepl_haystack-0.3.0/.pre-commit-config.yaml

@@ -0,0 +1,48 @@
+default_install_hook_types:
+  - pre-commit
+  - post-checkout
+  - post-merge
+  - post-rewrite
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v6.0.0
+  hooks:
+  - id: check-yaml
+  - id: check-json
+  - id: check-toml
+  - id: check-added-large-files
+    args:
+    - --maxkb=500
+  - id: end-of-file-fixer
+  - id: trailing-whitespace
+- repo: https://github.com/astral-sh/uv-pre-commit
+  rev: 0.8.14
+  hooks:
+  - id: uv-lock
+  - id: uv-sync
+    args: ["--locked", "--all-packages"]
+- repo: https://github.com/dribia/sync-with-uv
+  rev: v0.1.1
+  hooks:
+  - id: sync-with-uv
+- repo: https://github.com/python-jsonschema/check-jsonschema
+  rev: 0.33.3
+  hooks:
+  - id: check-github-workflows
+- repo: https://github.com/mrtazz/checkmake.git
+  rev: 0.2.2
+  hooks:
+  - id: checkmake
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.12.11
+  hooks:
+  - id: ruff-check
+    types_or: [ python, pyi ]
+    args:
+    - --fix
+  - id: ruff-format
+    types_or: [ python, pyi ]
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: v1.17.1
+  hooks:
+  - id: mypy

deepl_haystack-0.3.0/Makefile

@@ -0,0 +1,97 @@
+.PHONY: all clean check format lint lock test test-unit test-integration
+
+PROJECT ?= deepl_haystack
+TESTS ?= tests
+
+all:
+	make clean
+	make lint || exit 1
+	make test || exit 1
+
+clean:
+	rm -rf .pytest_cache
+	rm -rf .mypy_cache
+	rm -rf .ruff_cache
+
+check: format lint
+
+format:
+	uv run ruff format $(PROJECT) tests
+	uv run ruff check --fix --unsafe-fixes $(PROJECT) $(TESTS)
+
+--check-git-status:
+	@status=$$(git status --porcelain); \
+		if [ -n "$${status}" ]; \
+		then \
+			echo "ERROR:\n  GIT status is not clean.\
+			\n  Commit or discard your changes before using this script."; \
+			exit 1; \
+		fi
+
+lint:
+	uv run ruff format --check $(PROJECT) $(TESTS)
+	uv run ruff check $(PROJECT) $(TESTS)
+	uv run mypy $(PROJECT)
+
+lock:
+	uv lock --no-upgrade
+
+test:
+	uv run pytest --cov --cov-report=html --cov-report=xml
+
+test-unit:
+	uv run pytest --cov --cov-report=html --cov-report=xml -m "not integration"
+
+test-integration:
+	uv run pytest -m "integration"
+
+bump-version:
+	@make -- --check-git-status
+	@old_version=$$(uv version --dry-run --short); echo "Current version: $${old_version}"; \
+		bmp_vrs=$(COMMIT_VERSION); \
+		case $${bmp_vrs} in \
+			major|minor|patch) echo "Version bumping: $${bmp_vrs}"; uv version --bump $${bmp_vrs}; ;; \
+			*) echo "New version provided: $${bmp_vrs}"; uv version "$${bmp_vrs}"; ;; \
+		esac; \
+		new_version=$$(uv version --dry-run --short); \
+		if [ "$${new_version}" = "$${old_version}" ]; then \
+			echo "$${old_version} version update did not change the version number."; \
+			exit 0; \
+		else \
+			uv sync; \
+			uv run git commit pyproject.toml uv.lock -m ":bookmark: Bumping version from v$${old_version} to v$${new_version}"; \
+			git tag -a "v$${new_version}" -m ":bookmark: Bumping version from v$${old_version} to v$${new_version}"; \
+			echo "\nNew version: $${new_version}"; \
+		fi
+
+--setup-uv:
+	@echo "Checking if uv is installed ..."; \
+		uv_path=$$(command -v "uv"); \
+		if [ -z "$${uv_path}" ]; \
+		then \
+			echo "ERROR: uv not found.\
+			\n  You should have uv installed in order to setup this project.\
+			\n  https://docs.astral.sh/uv/getting-started/installation/\n"; \
+			exit 1; \
+		fi
+	@echo "Checking if uv.lock is up-to-date ..."; \
+		if uv lock --check > /dev/null 2>&1 ; \
+		then \
+			echo "uv.lock is up-to-date"; \
+            uv sync; \
+  			uv run pre-commit install --install-hooks; \
+		else \
+  			echo "uv.lock is NOT up-to-date."; \
+  			echo "Update uv.lock and commit it."; \
+			uv sync; \
+			uv run pre-commit install --install-hooks; \
+			git add uv.lock; \
+  			uv run pre-commit run --files uv.lock || true; \
+  			uv run git commit .pre-commit-config.yaml uv.lock -m ":lock: Lock the project dependencies"; \
+		fi
+
+setup:
+	@make -- --check-git-status || exit 1
+	@make -- --setup-uv || exit 1
+	@echo "Checking pre-commits ..."; poetry run pre-commit run --all-files || exit 1
+	@echo "\nSetup completed successfully!\n"; exit 0