compair-core 0.4.12__py3-none-any.whl

compair_core/server/providers/local_storage.py

@@ -0,0 +1,28 @@
+"""Local filesystem storage provider used in the Core edition."""
+from __future__ import annotations
+
+from pathlib import Path
+from typing import BinaryIO
+
+
+class LocalStorage:
+    def __init__(self, base_dir: str = "/data/uploads", base_url: str = "/uploads") -> None:
+        self.base_dir = Path(base_dir)
+        self.base_url = base_url.rstrip("/") or "/uploads"
+        self.base_dir.mkdir(parents=True, exist_ok=True)
+
+    def put_file(self, key: str, fileobj: BinaryIO, content_type: str) -> str:
+        destination = self.base_dir / key
+        destination.parent.mkdir(parents=True, exist_ok=True)
+        with destination.open("wb") as dest:
+            dest.write(fileobj.read())
+        return self.build_url(key)
+
+    def get_file(self, key: str) -> tuple[BinaryIO, str]:
+        path = self.base_dir / key
+        if not path.exists():
+            raise FileNotFoundError(key)
+        return path.open("rb"), "application/octet-stream"
+
+    def build_url(self, key: str) -> str:
+        return f"{self.base_url}/{key}".replace("//", "/")

compair_core/server/providers/noop_analytics.py

@@ -0,0 +1,7 @@
+"""Analytics provider placeholder that records no events."""
+from __future__ import annotations
+
+
+class NoopAnalytics:
+    def track(self, *_: object, **__: object) -> None:
+        return None

compair_core/server/providers/noop_billing.py

@@ -0,0 +1,30 @@
+"""Billing provider placeholder for the Core edition."""
+from __future__ import annotations
+
+from .contracts import BillingSession
+
+
+class NoopBilling:
+    def ensure_customer(self, **_: object) -> str:
+        raise NotImplementedError("Billing is not available in the Core edition.")
+
+    def create_checkout_session(self, **_: object) -> BillingSession:
+        raise NotImplementedError("Billing is not available in the Core edition.")
+
+    def retrieve_session(self, *_: object, **__: object) -> BillingSession:
+        raise NotImplementedError("Billing is not available in the Core edition.")
+
+    def get_checkout_url(self, *_: object, **__: object) -> str:
+        raise NotImplementedError("Billing is not available in the Core edition.")
+
+    def create_customer_portal(self, *_: object, **__: object) -> str:
+        raise NotImplementedError("Billing is not available in the Core edition.")
+
+    def create_coupon(self, *_: object, **__: object) -> str:
+        raise NotImplementedError("Billing is not available in the Core edition.")
+
+    def apply_coupon(self, *_: object, **__: object) -> None:
+        raise NotImplementedError("Billing is not available in the Core edition.")
+
+    def construct_event(self, *_: object, **__: object) -> dict[str, object]:
+        raise NotImplementedError("Billing is not available in the Core edition.")

compair_core/server/providers/noop_ocr.py

@@ -0,0 +1,10 @@
+"""OCR provider placeholder for the Core edition."""
+from __future__ import annotations
+
+
+class NoopOCR:
+    def submit(self, **_: object) -> str:
+        raise NotImplementedError("OCR is not available in the Core edition.")
+
+    def status(self, task_id: str) -> dict[str, object]:
+        return {"status": "unknown", "task_id": task_id}

compair_core/server/routers/capabilities.py

@@ -0,0 +1,46 @@
+"""Meta endpoints that describe edition capabilities for the CLI."""
+from __future__ import annotations
+
+from fastapi import APIRouter, Depends
+
+from ..settings import Settings, get_settings
+
+router = APIRouter(tags=["meta"])
+
+
+@router.get("/capabilities")
+def capabilities(settings: Settings = Depends(get_settings)) -> dict[str, object]:
+    edition = settings.edition.lower()
+    require_auth = settings.require_authentication
+    return {
+        "auth": {
+            "device_flow": edition == "cloud",
+            "password_login": require_auth,
+            "required": require_auth,
+            "single_user": not require_auth,
+        },
+        "inputs": {
+            "text": True,
+            "ocr": settings.ocr_enabled,
+            "repos": True,
+        },
+        "models": {
+            "premium": settings.premium_models,
+            "open": True,
+        },
+        "integrations": {
+            "slack": settings.integrations_enabled,
+            "github": settings.integrations_enabled,
+        },
+        "limits": {
+            "docs": None if edition == "core" else 100,
+            "feedback_per_day": None if edition == "core" else 50,
+        },
+        "features": {
+            "ocr_upload": settings.ocr_enabled,
+            "activity_feed": edition == "cloud",
+        },
+        "server": "Compair Cloud" if edition == "cloud" else "Compair Core",
+        "version": settings.version,
+        "legacy_routes": settings.include_legacy_routes,
+    }

compair_core/server/settings.py

@@ -0,0 +1,66 @@
+"""Application settings and feature flag definitions."""
+from functools import lru_cache
+
+from pydantic_settings import BaseSettings
+
+
+class Settings(BaseSettings):
+    """Configuration injected via COMPAIR_ environment variables."""
+
+    # Edition metadata
+    edition: str = "core"  # core | cloud
+    version: str = "dev"
+
+    # Feature gates
+    ocr_enabled: bool = True
+    billing_enabled: bool = False
+    integrations_enabled: bool = False
+    premium_models: bool = False
+    require_authentication: bool = False
+    require_email_verification: bool = False
+    single_user_username: str = "compair-local@example.com"
+    single_user_name: str = "Compair Local User"
+    include_legacy_routes: bool = False
+
+    # Core/local storage defaults
+    local_upload_dir: str = "~/.compair-core/data/uploads"
+    local_upload_base_url: str = "/uploads"
+
+    # Cloud storage (R2/S3-compatible)
+    r2_bucket: str | None = None
+    r2_cdn_base: str | None = None
+    r2_access_key: str | None = None
+    r2_secret_key: str | None = None
+    r2_endpoint_url: str | None = None
+
+    # Optional cloud secrets
+    stripe_key: str | None = None
+    stripe_endpoint_secret: str | None = None
+    stripe_success_url: str = "https://compair.sh/home"
+    stripe_cancel_url: str = "https://compair.sh/home"
+    ga4_measurement_id: str | None = None
+    ga4_api_secret: str | None = None
+
+    # Local model endpoints
+    local_model_url: str = "http://127.0.0.1:9000"
+    local_embedding_route: str = "/embed"
+    local_generation_route: str = "/generate"
+
+    # OCR
+    ocr_endpoint: str | None = "http://127.0.0.1:9001"
+    ocr_request_timeout: float = 30.0
+
+    class Config:
+        env_prefix = "COMPAIR_"
+
+
+@lru_cache
+def get_settings() -> Settings:
+    """Cached settings instance for dependency injection."""
+    settings = Settings()
+    # Auto-enable OCR when a local endpoint is configured (Core) unless explicitly disabled.
+    if settings.ocr_endpoint and not settings.ocr_enabled:
+        object.__setattr__(settings, "ocr_enabled", True)
+    if not settings.ocr_endpoint and settings.edition.lower() != "cloud":
+        object.__setattr__(settings, "ocr_enabled", False)
+    return settings

compair_core-0.4.12.dist-info/METADATA

@@ -0,0 +1,136 @@
+Metadata-Version: 2.4
+Name: compair-core
+Version: 0.4.12
+Summary: Open-source foundation of the Compair collaboration platform.
+Author: RocketResearch, Inc.
+License: MIT
+Project-URL: Homepage, https://github.com/RocketResearch-Inc/compair_core
+Project-URL: Documentation, https://github.com/RocketResearch-Inc/compair_core
+Project-URL: Source, https://github.com/RocketResearch-Inc/compair_core
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastapi>=0.110
+Requires-Dist: uvicorn>=0.29
+Requires-Dist: celery>=5.3
+Requires-Dist: sqlalchemy>=2.0
+Requires-Dist: pgvector>=0.2
+Requires-Dist: pydantic>=2.6
+Requires-Dist: pydantic-settings>=2.2
+Requires-Dist: requests>=2.31
+Requires-Dist: httpx>=0.27
+Requires-Dist: redis>=5.0
+Requires-Dist: psutil>=5.9
+Requires-Dist: python-Levenshtein>=0.23
+Requires-Dist: redmail>=0.6
+Requires-Dist: python-multipart>=0.0.20
+Provides-Extra: dev
+Requires-Dist: build>=1.0; extra == "dev"
+Requires-Dist: twine>=5.0; extra == "dev"
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: ruff>=0.3; extra == "dev"
+Provides-Extra: ocr
+Requires-Dist: pillow>=10.0; extra == "ocr"
+Requires-Dist: pytesseract>=0.3.10; extra == "ocr"
+Requires-Dist: pypdf>=4.0; extra == "ocr"
+Provides-Extra: postgres
+Requires-Dist: psycopg2-binary>=2.9; extra == "postgres"
+Dynamic: license-file
+
+# Compair Core
+
+Compair Core is the open-source foundation of the Compair platform. It bundles the shared data models, FastAPI application, email utilities, and local-only helpers so that you can run Compair in a self-hosted or evaluation environment without premium cloud integrations.
+
+The premium cloud offering (available at [https://www.compair.sh/](https://www.compair.sh/)) layers on premium services (premium models, OCR, storage,  etc.). Core gracefully falls back to local behaviour when those packages are not present.
+
+## Repository Layout
+
+| Path | Purpose |
+| --- | --- |
+| `compair/` | Core runtime (ORM models, tasks, embeddings, feedback). |
+| `server/` | FastAPI app factory and dependency providers used by both editions. |
+| `compair_email/` | Console mailer + minimal templates for account verification and password reset. |
+| `docs/` | Additional documentation (see `docs/editions.md` for an overview of the two editions). |
+
+## Installing
+
+```bash
+pip install compair-core
+```
+
+This installs the package as a dependency so you can embed Compair into your own FastAPI instance or reuse the models in scripts. The core library exposes hooks for the private cloud extension that Compair itself uses for hosted deployments.
+
+### Installing from source
+
+You can also install directly from GitHub (handy for pinning to a specific commit or branch):
+
+```bash
+pip install "git+https://github.com/RocketResearch-Inc/compair_core.git@main"
+```
+
+For local development:
+
+```bash
+git clone https://github.com/RocketResearch-Inc/compair_core.git
+cd compair_core
+python -m venv .venv
+source .venv/bin/activate
+pip install -e ".[dev]"
+```
+
+> 🔧 The optional OCR stack relies on the Tesseract CLI. When running outside the container image, install Tesseract separately (for example, `brew install tesseract` on macOS or `apt-get install tesseract-ocr` on Debian/Ubuntu) so pytesseract can invoke it.
+
+## Containers
+
+Container definitions and build pipelines live outside this public package:
+
+- The **core** container lives alongside the private CI workflow in the `compair_cloud` repository (`Dockerfile.core`). It installs this package from PyPI and runs the FastAPI factory with SQLite defaults.
+- A **cloud** container (`Dockerfile.cloud`) is built from a private cloud extension that enables premium features. For more information, please visit [https://www.compair.sh/](https://www.compair.sh/).
+
+## Configuration
+
+Key environment variables for the core edition:
+
+- `COMPAIR_EDITION` (`core`) – corresponds to this core local implementation.
+- `COMPAIR_DATABASE_URL` – optional explicit SQLAlchemy URL (e.g. `postgresql+psycopg2://user:pass@host/db`). When omitted, Compair falls back to a local SQLite file.
+- `COMPAIR_DB_DIR` / `COMPAIR_DB_NAME` – directory and filename for the bundled SQLite database (default: `~/.compair-core/data/compair.db`). Legacy `COMPAIR_SQLITE_*` variables remain supported.
+- `COMPAIR_LOCAL_MODEL_URL` – endpoint for your local embeddings/feedback service (defaults to `http://127.0.0.1:9000`).
+- `COMPAIR_EMBEDDING_PROVIDER` – choose `local` (default) or `openai` for embeddings independent of feedback.
+- `COMPAIR_OPENAI_EMBED_MODEL` – override the OpenAI embedding model when `COMPAIR_EMBEDDING_PROVIDER=openai`.
+- `COMPAIR_EMAIL_BACKEND` – the core mailer logs emails to stdout; cloud overrides this with transactional delivery.
+- `COMPAIR_REQUIRE_AUTHENTICATION` (`true`) – set to `false` to run the API in single-user mode without login or account management. When disabled, Compair auto-provisions a local user, group, and long-lived session token so you can upload documents immediately.
+- `COMPAIR_REQUIRE_EMAIL_VERIFICATION` (`false`) – require new users to confirm via email before activation. Set to `true` only when SMTP credentials are configured.
+- `COMPAIR_SINGLE_USER_USERNAME` / `COMPAIR_SINGLE_USER_NAME` – override the email-style username and display name that are used for the auto-provisioned local user in single-user mode.
+- `COMPAIR_INCLUDE_LEGACY_ROUTES` (`false`) – opt-in to the full legacy API surface (used by the hosted product) when running the core edition. Leave unset to expose only the streamlined single-user endpoints in Swagger.
+- `COMPAIR_EMBEDDING_DIM` – force the embedding vector size stored in the database (defaults to 384 for core, 1536 for cloud). Keep this in sync with whichever embedding model you configure.
+- `COMPAIR_VECTOR_BACKEND` (`auto`) – set to `pgvector` when running against PostgreSQL with the pgvector extension, or `json` to store embeddings as JSON (the default for SQLite deployments).
+- `COMPAIR_GENERATION_PROVIDER` (`local`) – choose how feedback is produced. Options: `local` (call the bundled FastAPI service), `openai` (use ChatGPT-compatible APIs with an API key), `http` (POST the request to a custom endpoint), or `fallback` (skip generation and surface similar references only).
+- `COMPAIR_OPENAI_API_KEY` / `COMPAIR_OPENAI_MODEL` – when using the OpenAI provider, supply your API key and optional model name (defaults to `gpt-5-nano`). The fallback kicks in automatically if the key or SDK is unavailable.
+- `COMPAIR_GENERATION_ENDPOINT` – HTTP endpoint invoked when `COMPAIR_GENERATION_PROVIDER=http`; the service receives a JSON payload (`document`, `references`, `length_instruction`) and should return `{"feedback": ...}`.
+- `COMPAIR_OCR_ENDPOINT` – endpoint the backend calls for OCR uploads. Setting this (e.g., to the bundled Tesseract wrapper at `http://127.0.0.1:9001/ocr-file`) automatically enables OCR.
+- `COMPAIR_OCR_REQUEST_TIMEOUT` – timeout in seconds for HTTP OCR requests (default `30`).
+
+When verification is required, configure `EMAIL_HOST`, `EMAIL_USER`, and `EMAIL_PW` so the mailer can deliver verification and password reset emails.
+
+See `compair_core/server/settings.py` for the full settings surface.
+
+## Developing Locally
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+pip install -e ".[dev]"
+uvicorn compair_core.server.app:create_app --factory --reload
+```
+
+The API will be available at http://127.0.0.1:8000 and supports the Swagger UI at `/docs`.
+
+## Tests / Linting
+
+Core currently ships with a syntax sanity check (`python -m compileall ...`). You can add pytest or other tooling as needed.
+
+Release and packaging steps are documented in `docs/maintainers.md`.
+
+## Reporting Issues
+
+Please open GitHub issues or PRs against this repository. If you are a Compair Cloud customer, reach out through your support channel for issues related to premium features.

compair_core-0.4.12.dist-info/RECORD

@@ -0,0 +1,41 @@
+compair_core/__init__.py,sha256=ktPgTk1QCd7PF-CUzfcd49JvkEut68SEefx2qcL5M5s,122
+compair_core/api.py,sha256=LWefBRIV54hjaWuYQVosHRxfpkZBztN4Kswn5_LKd2Q,138239
+compair_core/db.py,sha256=eOFnwD4VLRre_zk5iR-sh3Gd2MUqO5v7XTCIV-eVMHg,1989
+compair_core/compair/__init__.py,sha256=Tt_wPW8GrE5Kp1PvtiT_w_LN458ysr9x6Xa-xhXq1uM,1753
+compair_core/compair/celery_app.py,sha256=S-xt38oBz08wMofgcJ-Yk9L1fhead6q1Y_VpXyjcxfw,881
+compair_core/compair/default_groups.py,sha256=dbacrFkSjqEQZ_uoFU5gYhgIoP_3lmvz6LJNHCJvxlw,498
+compair_core/compair/embeddings.py,sha256=iAJBAEZmbeFe5bOdgKt79Ndv79ZZnIrkqKvvw0VX5Yk,5803
+compair_core/compair/feedback.py,sha256=45s6hzWH_3y3grl0-_s0RzIoyag_sedNYJrcoPF-ANI,15228
+compair_core/compair/logger.py,sha256=mB9gV3FfC0qE_G9NBErpEAJhyGxDxEVKqWKu3n8hOkc,802
+compair_core/compair/main.py,sha256=cRk7azCCMY1F4e5hjF0NH9Wxv2nDUq3FBf8KGEGAmjY,9227
+compair_core/compair/models.py,sha256=0ysM2HG1E8j4MmW6P7abEgNFfor_yfFffScYIl8xku8,16590
+compair_core/compair/schema.py,sha256=TxQpDQ96J_tIj-Y_1C_x2eUYn9n_LOG6XiNLCX1-GYY,2902
+compair_core/compair/tasks.py,sha256=HHf2Kk2_okfJqzbZV6GOrP3st4HuWDaPHEGvYT48iW4,4093
+compair_core/compair/utils.py,sha256=7bbkRb-9zmPAogqR7zQHLnQUkoeW9bwhqPz2S5FRKSc,978
+compair_core/compair_email/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+compair_core/compair_email/email.py,sha256=bedTrcfmi4K2kB0B2bSbryhq5k_4C-QNtb8wZjvzKAs,238
+compair_core/compair_email/email_core.py,sha256=da7JxTo5ude55mB7UNLlpNp8xenYwoPaqyTunxjU7to,316
+compair_core/compair_email/templates.py,sha256=JVlLdJEcpu14mVKRAYRIPIw2JGy70kG70mfjXgby-To,206
+compair_core/compair_email/templates_core.py,sha256=1XzBXGjmM6gApSXq382fxCRiVa5J-iskC3r9QQvmV1U,967
+compair_core/server/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+compair_core/server/app.py,sha256=-pYKPsn0TIL75oJXPdHEHDFnEssDbdJgOW1JnBvh9w0,3692
+compair_core/server/deps.py,sha256=zjcnGJv7MHsZneewjuSSd6_JESfAWjQgXeXoYxmwvmg,1915
+compair_core/server/settings.py,sha256=FdrUoAgmUpkC91ZlwUlTx3JzuVYkh_bz43vgGsCa_gY,2194
+compair_core/server/local_model/__init__.py,sha256=YlzDgorgAjGou9d_W29Xp3TVu08e4t9x8csFxn8cgSE,50
+compair_core/server/local_model/app.py,sha256=943dnixGcaxHixBXVgJmG5G69gisFcwcIh65NJ5scGU,2552
+compair_core/server/local_model/ocr.py,sha256=Y-njNUWDIGvrnL3MefuWkxtfckcWW9RawJJu5PCvdgk,3460
+compair_core/server/providers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+compair_core/server/providers/console_mailer.py,sha256=7ady954yOPlT8t3spkDvdMdO3BTwosJUj1cpVNOwj8U,308
+compair_core/server/providers/contracts.py,sha256=pYA_2AaPHw089O_UP2JtWRHbIiVkoNGhLuesuNATowU,1858
+compair_core/server/providers/http_ocr.py,sha256=X5_CFHIzREWuXdN3_4CiDZ9hjuHzeoROUNeenDkxQVg,1711
+compair_core/server/providers/local_storage.py,sha256=UNCDHejeWlDlPVDRdwsN13toNRi_qHiaX-kbmzxf0OA,1054
+compair_core/server/providers/noop_analytics.py,sha256=OKw23SObxBlQzFdB0xEBg5qD1Fcq_bcx6OOb4S3Mbd0,194
+compair_core/server/providers/noop_billing.py,sha256=V18Cpl1D1reM3xhgw-lShGliVpYO8IsiAPWOAIR34jM,1358
+compair_core/server/providers/noop_ocr.py,sha256=fMaJrivDef38-ECgIuTXUBCIm_avgvZf3nQ3UTdFPNI,341
+compair_core/server/routers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+compair_core/server/routers/capabilities.py,sha256=hM7HNM6efkyZ7xk0-CLI31qMJvbKM1MwC7xBgj_5-Qw,1479
+compair_core-0.4.12.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+compair_core-0.4.12.dist-info/METADATA,sha256=_W4cxc3NdGAeX2grGdAWYhRoOFUMBpWc11J5DJATUOk,7921
+compair_core-0.4.12.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+compair_core-0.4.12.dist-info/top_level.txt,sha256=1dpwoLSY2DWQUVGS05Tq0MuFXg8sabYzg4V2deLzzuo,13
+compair_core-0.4.12.dist-info/RECORD,,

compair_core-0.4.12.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+