Merge branch 'main' into main

Author: geritwagner

.github/workflows/documentation.yml

@@ -16,49 +16,37 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
 
     - name: Set up Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: '3.10'
 
-    - name: Set POETRY_CACHE_DIR
-      run: echo "POETRY_CACHE_DIR=${{runner.temp}}/poetry_cache" >> $GITHUB_ENV
-    - name: Install Poetry
+    - name: Install uv and dependencies
       run: |
-        curl -sSL https://install.python-poetry.org | python3 -
-        echo "Poetry installed successfully"
-
-    - name: Install dependencies
-      run: |
-        poetry install --extras "docs"
+        pip install uv
+        uv venv
+        uv pip install -e .[docs]
         echo "Dependencies installed successfully"
-      env:
-        POETRY_VIRTUALENVS_CREATE: false
-        POETRY_CACHE_DIR: .cache/poetry
 
     - name: Build documentation
       run: |
-        sphinx-build -b html docs/source _build/html
+        uv run sphinx-build -b html docs/source _build/html
         echo "Documentation built successfully"
 
     - name: Upload Pages Artifact
-      uses: actions/upload-pages-artifact@v1
+      uses: actions/upload-pages-artifact@v3
       with:
         path: ./_build/html
 
   deploy:
-    needs: build
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
     runs-on: ubuntu-latest
-
-    permissions:
-      contents: read
-      id-token: write
-      pages: write
-
+    needs: build
     steps:
-    - name: Deploy to GitHub Pages
-      uses: actions/deploy-pages@v1
-      with:
-        token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/poetry_update.yml

@@ -3,15 +3,25 @@ on:
   workflow_dispatch:
   release:
     types: [published]
+
 jobs:
   pypi:
+    permissions:
+      id-token: write
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-      - name: Install poetry
-        run: pipx install poetry
-      - name: Setup poetry
-        run: poetry config pypi-token.pypi ${{ secrets.PYPI_API_TOKEN }}
-      - name: Publish package
-        run: poetry publish --build
+      - uses: actions/checkout@v4
+
+      - name: Install uv and set the python version with caching
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: 3.11
+
+      - name: Install the project
+        run: uv sync --all-extras
+
+      - name: Build
+        run: uv build
+
+      - name: Publish
+        run: uv publish

.github/workflows/publish.yml

@@ -12,24 +12,28 @@ jobs:
         python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
     runs-on: ${{ matrix.platform }}
     steps:
-      - uses: actions/checkout@v3
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Install poetry
-        run: pipx install poetry
-      - name: Install poetry dependencies
+          enable-cache: true
+
+      - name: Install dependencies with uv
         run: |
-          poetry install -E dev
-          poetry show
+          uv venv
+          uv pip install -e .[dev]
+          echo "Dependencies installed successfully"
+
       - name: Setup git
         run: |
           git config --global user.name "Search-query test"
           git config --global user.email "actions@users.noreply.github.com"
           git config --global url.https://github.com/.insteadOf git://github.com/
-      - name: Run poetry tests
-        run: poetry run pytest test -vv
+
+      - name: Run tests with uv
+        run: uv run pytest test -vv
 
   pip-install:
     strategy:
@@ -38,19 +42,23 @@ jobs:
         python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
     runs-on: ${{ matrix.platform }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
+
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
+
       - name: Install via pip
         run: |
           pip install -e .[dev]
           pip list
+
       - name: Setup git
         run: |
           git config --global user.name "Search-query test"
           git config --global user.email "actions@users.noreply.github.com"
           git config --global url.https://github.com/.insteadOf git://github.com/
+
       - name: Run tests
         run: pytest test -vv

.github/workflows/tests.yml

@@ -0,0 +1,7 @@
+-   id: search-file-lint
+    name: lint search files
+    description: Linter for search files based on the search-query package.
+    entry: search-file-lint
+    language: python
+    stages: [pre-commit, pre-push, manual]
+    minimum_pre_commit_version: 3.2.0

.pre-commit-hooks.yaml

@@ -1,7 +1,7 @@
-#  Welcome to search-query
-
 <div align="center">
 
+#  search-query
+
 [![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/CoLRev-Environment/search-query/.github%2Fworkflows%2Ftests.yml?label=tests)](https://github.com/CoLRev-Environment/search-query/actions/workflows/tests.yml)
 [![GitHub Release](https://img.shields.io/github/v/release/CoLRev-Environment/search-query)](https://github.com/CoLRev-Environment/search-query/releases/)
 [![PyPI - Version](https://img.shields.io/pypi/v/search-query?color=blue)](https://pypi.org/project/search-query/)
@@ -39,10 +39,8 @@ query = AndQuery([digital_synonyms, work_synonyms], search_field="Author Keyword
 
 Parameters:
 
-- list of strings or queries: strings which you want to include in the search query,
-- search field: search field to which the query should be applied (available options: TODO: GIVE EXAMPLES AND LINK TO DOCS)
-
-**TODO : implement a user-friendly version of OrQuery / AndQuery, which accepts lists of strings/queries and search_fields as strings**
+- list of strings or queries: strings that you want to include in the search query,
+- `search_field`: search field to which the query should be applied (available options: TODO: GIVE EXAMPLES AND LINK TO DOCS)
 
 To load a JSON query file, run the parser:
 
@@ -107,7 +105,18 @@ search-query lint search-file.json
 
 Linters can be included as pre-commit hooks by adding the following to the `.pre-commit-config.yaml:
 
+```yaml
+repos:
+  - repo: https://github.com/CoLRev-Environment/search-query
+    rev: main # or version of search-query
+    hooks:
+      - id: search-file-lint
+
 ```
+
+For development and testing, use the following:
+
+```yaml
 repos:
   - repo: local
     hooks:
@@ -118,17 +127,6 @@ repos:
         files: \.json$
 ```
 
-<!--
-TODO: the previous one should be for dev. Enable (based on [.pre-commit-hooks.yaml](https://github.com/pre-commit/pre-commit-hooks/blob/main/.pre-commit-hooks.yaml)):
-
-```
--   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0  # Use the ref you want to point at
-    hooks:
-    -   id: trailing-whitespace
-```
--->
-
 To activate and run:
 
 ```
@@ -154,7 +152,7 @@ The package was developed as part of Bachelor's theses:
 
 ## Not what you are looking for?
 
-This python package was developed with purpose of integrating it into other literature management tools. If that isn't your use case, it migth be useful for you to look at these related tools:
+This Python package was developed with purpose of integrating it into other literature management tools. If that isn't your use case, it might be useful for you to look at these related tools:
 
 - [LitSonar](https://litsonar.com/)
 - [Polyglot](https://sr-accelerator.com/#/polyglot)