Added the search cli command

.github/workflows/docbinder-oss.yml → .github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: DocBinder OSS Library CI/CD
+name: DocBinder OSS Library CI
 
 on:
   pull_request:
@@ -40,7 +40,7 @@ jobs:
 
       - name: Lint code with uv
         run: |
-          uv tool run ruff check
+          uv tool run pre-commit
 
       - name: Run tox with uv
         run: |

.github/workflows/pypi-publish.yml

@@ -1,4 +1,4 @@
-name: Publish to PyPI
+name: DocBinder OSS Publish to PyPI
 # This workflow publishes the package to PyPI when a new tag is created on the main branch.
 on:
   push:

.gitignore

@@ -77,3 +77,7 @@ ENV/
 # Credentials
 gcp_credentials.json
 *_token.json
+
+# Test files
+search_results.csv
+search_results.json

.pre-commit-config.yaml

@@ -0,0 +1,24 @@
+repos:
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    rev: 0.7.16
+    hooks:
+      - id: uv-export
+      - id: uv-lock
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.12.1
+    hooks:
+    # Run the linter.
+    - id: ruff-check
+      types_or: [ python, pyi ]
+      args: [ --select, I, --fix, --select=E501 ]
+    # Run the formatter.
+    - id: ruff-format
+      types_or: [ python, pyi ]

CONTRIBUTING.md

@@ -56,4 +56,26 @@ All dependencies are tracked in `pyproject.toml`. Use `uv` commands to keep it u
 ---
 
 **Note:**  
-Always use `uv` commands to manage dependencies and environments to keep `pyproject.toml` in sync.
+Always use `uv` commands to manage dependencies and environments to keep `pyproject.toml` in sync.
+
+## Code Style and Linting
+
+This project uses [Black](https://black.readthedocs.io/en/stable/) for code formatting and [Ruff](https://docs.astral.sh/ruff/) for linting. All code should be formatted and linted before committing.
+
+- Run the following before committing code:
+
+```zsh
+uv run black .
+uv run ruff check .
+```
+
+- To automatically format and lint code on every commit, install pre-commit hooks:
+
+```zsh
+uv pip install pre-commit
+pre-commit install
+```
+
+This will ensure Black and Ruff are run on staged files before each commit.
+
+Configuration for Black and Ruff is in `pyproject.toml`. This enforces consistent quotes, spacing, and other style rules for all contributors.

docs/CONTRIBUTING.md

@@ -56,4 +56,26 @@ All dependencies are tracked in `pyproject.toml`. Use `uv` commands to keep it u
 ---
 
 **Note:**  
-Always use `uv` commands to manage dependencies and environments to keep `pyproject.toml` in sync.
+Always use `uv` commands to manage dependencies and environments to keep `pyproject.toml` in sync.
+
+## Code Style and Linting
+
+This project uses [Black](https://black.readthedocs.io/en/stable/) for code formatting and [Ruff](https://docs.astral.sh/ruff/) for linting. All code should be formatted and linted before committing.
+
+- Run the following before committing code:
+
+```zsh
+uv run black .
+uv run ruff check .
+```
+
+- To automatically format and lint code on every commit, install pre-commit hooks:
+
+```zsh
+uv pip install pre-commit
+pre-commit install
+```
+
+This will ensure Black and Ruff are run on staged files before each commit.
+
+Configuration for Black and Ruff is in `pyproject.toml`. This enforces consistent quotes, spacing, and other style rules for all contributors.

docs/tool/providers/custom_provider.md

@@ -6,7 +6,7 @@ This guide explains how to integrate a new storage provider (e.g., DropBox, OneD
 
 ## 1. Create a Service Configuration Class
 
-Each provider must define a configuration class that inherits from [`ServiceConfig`](src/docbinder_oss/services/base_class.py):
+Each provider must define a configuration class that inherits from [`ServiceConfig`](https://github.com/SnappyLab/DocBinder-OSS/blob/main/src/docbinder_oss/services/base_class.py):
 
 ```python
 # filepath: src/docbinder_oss/services/my_provider/my_provider_service_config.py
@@ -26,7 +26,7 @@ class MyProviderServiceConfig(ServiceConfig):
 
 ## 2. Implement the Storage Client
 
-Create a client class that inherits from [`BaseStorageClient`](src/docbinder_oss/services/base_class.py) and implements all abstract methods:
+Create a client class that inherits from [`BaseStorageClient`](https://github.com/SnappyLab/DocBinder-OSS/blob/main/src/docbinder_oss/services/base_class.py) and implements all abstract methods:
 
 ```python
 # filepath: src/docbinder_oss/services/my_provider/my_provider_client.py
@@ -57,7 +57,7 @@ class MyProviderClient(BaseStorageClient):
         pass
 ```
 
-- Use the shared models [`File`](src/docbinder_oss/core/schemas.py), [`Permission`](src/docbinder_oss/core/schemas.py), etc., for return types.
+- Use the shared models [`File`](https://github.com/SnappyLab/DocBinder-OSS/blob/main/src/docbinder_oss/core/schemas.py), [`Permission`](https://github.com/SnappyLab/DocBinder-OSS/blob/main/src/docbinder_oss/core/schemas.py), etc., for return types.
 
 ---
 
@@ -109,10 +109,10 @@ providers:
 
 ## Reference
 
-- [src/docbinder_oss/services/base_class.py](src/docbinder_oss/services/base_class.py)
-- [src/docbinder_oss/core/schemas.py](src/docbinder_oss/core/schemas.py)
-- [src/docbinder_oss/services/google_drive/](src/docbinder_oss/services/google_drive/) (example implementation)
-- [src/docbinder_oss/services/__init__.py](src/docbinder_oss/services/__init__.py)
+- [src/docbinder_oss/services/base_class.py](https://github.com/SnappyLab/DocBinder-OSS/blob/main/src/docbinder_oss/services/base_class.py)
+- [src/docbinder_oss/core/schemas.py](https://github.com/SnappyLab/DocBinder-OSS/blob/main/src/docbinder_oss/core/schemas.py)
+- [src/docbinder_oss/services/google_drive/](https://github.com/SnappyLab/DocBinder-OSS/tree/main/src/docbinder_oss/services/google_drive/) (example implementation)
+- [src/docbinder_oss/services/__init__.py](https://github.com/SnappyLab/DocBinder-OSS/blob/main/src/docbinder_oss/services/__init__.py)
 
 ---
 

docs/tool/providers/google_drive.md

@@ -65,4 +65,4 @@ providers:
 ## References
 
 - [Google Drive API Documentation](https://developers.google.com/drive)
-- [DocBinder Documentation](../README.md)
+- [DocBinder OSS - GitHub](https://github.com/SnappyLab/DocBinder-OSS)

mkdocs.yml

@@ -10,6 +10,9 @@ nav:
       - Commands:
           - Main CLI: commands/main.md
           - Provider: commands/provider.md
+  - Providers:
+      - Google Drive: tool/providers/google_drive.md
+      - Custom Provider: tool/providers/custom_provider.md
   - Contributing: CONTRIBUTING.md
   - Code of Conduct: CODE_OF_CONDUCT.md
   - Security: SECURITY.md

provider_setup_example.yml

@@ -0,0 +1,4 @@
+providers:
+  - type: google_drive
+    name: my_google_drive
+    gcp_credentials_json: gcp_credentials.json

pyproject.toml

@@ -34,6 +34,7 @@ include = ["src/docbinder_oss/**"]
 dev = [
     "mkdocs>=1.6.1",
     "mkdocs-material>=9.6.14",
+    "pre-commit>=4.2.0",
     "pytest>=8.4.0",
     "tox>=4.26.0",
     "tox-uv>=1.26.0",
@@ -47,8 +48,7 @@ testpaths = [
 ]
 
 [tool.ruff]
-# Set the maximum line length to 100.
-line-length = 100
+line-length = 125
 
 [tool.ruff.lint]
 # Add the `line-too-long` rule to the enforced rule set. By default, Ruff omits rules that

src/docbinder_oss/cli/provider/__init__.py

@@ -0,0 +1,12 @@
+import typer
+from .get import app as get_app
+from .list import app as list_app
+from .test import app as test_app
+
+# --- Provider Subcommand Group ---
+# We create a separate Typer app for the 'provider' command.
+# This allows us to nest commands like 'provider list' and 'provider get'.
+app = typer.Typer(help="Commands to manage providers. List them or get details for a specific one.")
+app.add_typer(get_app)
+app.add_typer(list_app)
+app.add_typer(test_app)

src/docbinder_oss/cli/provider/get.py

@@ -0,0 +1,30 @@
+import typer
+
+app = typer.Typer()
+
+
+@app.command("get")
+def get_provider(
+    connection_type: str = typer.Option(None, "--type", "-t", help="The type of the provider to get."),
+    name: str = typer.Option(None, "--name", "-n", help="The name of the provider to get."),
+):
+    """Get connection information for a provider by name or by type.
+    If both options are provided, it will search for providers matching either criterion."""
+    from docbinder_oss.helpers.config import load_config
+
+    config = load_config()
+
+    provider_found = False
+    if not config.providers:
+        typer.echo("No providers configured.")
+        raise typer.Exit(code=1)
+    for provider in config.providers:
+        if provider.name == name:
+            typer.echo(f"Provider '{name}' found with config: {provider}")
+            provider_found = True
+        if provider.type == connection_type:
+            typer.echo(f"Provider '{provider.name}' of type '{connection_type}'" f" found with config: {provider}")
+            provider_found = True
+    if not provider_found:
+        typer.echo(f"No providers found with name '{name}' or type '{connection_type}'.")
+        raise typer.Exit(code=1)

src/docbinder_oss/cli/provider/list.py

@@ -0,0 +1,17 @@
+import typer
+
+app = typer.Typer()
+
+
+@app.command()
+def list():
+    """List all configured providers."""
+    from docbinder_oss.helpers.config import load_config
+
+    config = load_config()
+    if not config.providers:
+        typer.echo("No providers configured.")
+        raise typer.Exit(code=1)
+
+    for provider in config.providers:
+        typer.echo(f"Provider: {provider.name}, type: {provider.type}")

src/docbinder_oss/cli/provider/test.py

@@ -0,0 +1,46 @@
+import typer
+from typing import Annotated
+
+app = typer.Typer()
+
+
+@app.command("test")
+def test(
+    name: Annotated[str, typer.Argument(help="The name of the provider to test the connection.")],
+):
+    """Test the connection to a specific provider."""
+    from docbinder_oss.helpers.config import load_config
+    from docbinder_oss.providers import create_provider_instance
+
+    if not name:
+        typer.echo("Provider name is required.")
+        raise typer.Exit(code=1)
+
+    config = load_config()
+    if not config.providers:
+        typer.echo("No providers configured.")
+        raise typer.Exit(code=1)
+
+    found_provider_config = None
+    for provider_config in config.providers:
+        if provider_config.name == name:
+            found_provider_config = provider_config
+            break  # Exit the loop once the provider is found
+
+    if found_provider_config:
+        typer.echo(f"Testing connection for provider '{name}'...")
+        try:
+            client = create_provider_instance(found_provider_config)
+            if client is None:
+                typer.echo(f"Provider '{name}' is not supported or not implemented.")
+                raise typer.Exit(code=1)
+            # Attempt to test the connection
+            client.test_connection()
+            typer.echo(f"Connection to provider '{name}' is successful.")
+        except Exception as e:
+            typer.echo(f"Failed to connect to provider '{name}': {e}")
+        return
+
+    # If we reach here, the provider was not found
+    typer.echo(f"Provider '{name}' not found in configuration.")
+    raise typer.Exit(code=1)