compair-core 0.3.9__tar.gz → 0.3.11__tar.gz

{compair_core-0.3.9 → compair_core-0.3.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: compair-core
-Version: 0.3.9
+Version: 0.3.11
 Summary: Open-source foundation of the Compair collaboration platform.
 Author: RocketResearch, Inc.
 License: MIT
@@ -23,6 +23,7 @@ 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"
@@ -88,6 +89,8 @@ Key environment variables for the core edition:
 - `COMPAIR_SQLITE_DIR` / `COMPAIR_SQLITE_NAME` – override the default local SQLite path (falls back to `./compair_data` if `/data` is not writable).
 - `COMPAIR_LOCAL_MODEL_URL` – endpoint for your local embeddings/feedback service (defaults to `http://local-model:9000`).
 - `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_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.
 
 See `compair_core/server/settings.py` for the full settings surface.
 

{compair_core-0.3.9 → compair_core-0.3.11}/README.md

@@ -54,6 +54,8 @@ Key environment variables for the core edition:
 - `COMPAIR_SQLITE_DIR` / `COMPAIR_SQLITE_NAME` – override the default local SQLite path (falls back to `./compair_data` if `/data` is not writable).
 - `COMPAIR_LOCAL_MODEL_URL` – endpoint for your local embeddings/feedback service (defaults to `http://local-model:9000`).
 - `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_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.
 
 See `compair_core/server/settings.py` for the full settings surface.
 

{compair_core-0.3.9 → compair_core-0.3.11}/compair_core/api.py

@@ -36,10 +36,13 @@ from .compair_email.templates import (
 )
 from .compair.tasks import process_document_task as process_document_celery, send_feature_announcement_task, send_deactivate_request_email, send_help_request_email
 
-import redis
+try:
+    import redis  # type: ignore
+except ImportError:  # pragma: no cover - optional dependency
+    redis = None
 
 redis_url = os.environ.get("REDIS_URL")
-redis_client = redis.Redis.from_url(redis_url)
+redis_client = redis.Redis.from_url(redis_url) if (redis and redis_url) else None
 #from compair.main import process_document
 
 router = APIRouter()
@@ -56,6 +59,112 @@ GA4_MEASUREMENT_ID = os.getenv("GA4_MEASUREMENT_ID")
 GA4_API_SECRET = os.getenv("GA4_API_SECRET")
 
 IS_CLOUD = os.getenv("COMPAIR_EDITION", "core").lower() == "cloud"
+SINGLE_USER_SESSION_TTL = timedelta(days=365)
+
+
+def _ensure_single_user(session: Session, settings: Settings) -> models.User:
+    """Create or fetch the singleton user used when authentication is disabled."""
+    changed = False
+    user = (
+        session.query(models.User)
+        .options(joinedload(models.User.groups))
+        .filter(models.User.username == settings.single_user_username)
+        .first()
+    )
+    if user is None:
+        now = datetime.now(timezone.utc)
+        user = models.User(
+            username=settings.single_user_username,
+            name=settings.single_user_name,
+            datetime_registered=now,
+            verification_token=None,
+            token_expiration=None,
+        )
+        user.set_password(secrets.token_urlsafe(16))
+        user.status = "active"
+        user.status_change_date = now
+        session.add(user)
+        session.flush()
+        admin = models.Administrator(user_id=user.user_id)
+        group = models.Group(
+            name=user.username,
+            datetime_created=now,
+            group_image=None,
+            category="Private",
+            description=f"Private workspace for {settings.single_user_name}",
+            visibility="private",
+        )
+        group.admins.append(admin)
+        user.groups = [group]
+        session.add_all([group, admin])
+        changed = True
+    else:
+        now = datetime.now(timezone.utc)
+        if user.status != "active":
+            user.status = "active"
+            user.status_change_date = now
+            changed = True
+        group = next((g for g in user.groups if g.name == user.username), None)
+        if group is None:
+            group = session.query(models.Group).filter(models.Group.name == user.username).first()
+            if group is None:
+                group = models.Group(
+                    name=user.username,
+                    datetime_created=now,
+                    group_image=None,
+                    category="Private",
+                    description=f"Private workspace for {user.name}",
+                    visibility="private",
+                )
+                session.add(group)
+                changed = True
+            if group not in user.groups:
+                user.groups.append(group)
+                changed = True
+        admin = session.query(models.Administrator).filter(models.Administrator.user_id == user.user_id).first()
+        if admin is None:
+            admin = models.Administrator(user_id=user.user_id)
+            session.add(admin)
+            changed = True
+        if admin not in group.admins:
+            group.admins.append(admin)
+            changed = True
+
+    if changed:
+        session.commit()
+        user = (
+            session.query(models.User)
+            .options(joinedload(models.User.groups))
+            .filter(models.User.username == settings.single_user_username)
+            .first()
+        )
+    if user is None:
+        raise RuntimeError("Failed to initialize the local Compair user.")
+    user.groups  # ensure relationship is loaded before detaching
+    return user
+
+
+def _ensure_single_user_session(session: Session, user: models.User) -> models.Session:
+    """Return a long-lived session token for the singleton user."""
+    now = datetime.now(timezone.utc)
+    existing = (
+        session.query(models.Session)
+        .filter(models.Session.user_id == user.user_id, models.Session.datetime_valid_until >= now)
+        .order_by(models.Session.datetime_valid_until.desc())
+        .first()
+    )
+    if existing:
+        return existing
+    token = secrets.token_urlsafe()
+    user_session = models.Session(
+        id=token,
+        user_id=user.user_id,
+        datetime_created=now,
+        datetime_valid_until=now + SINGLE_USER_SESSION_TTL,
+    )
+    session.add(user_session)
+    session.commit()
+    return user_session
 
 
 def require_cloud(feature: str) -> None:
@@ -80,13 +189,20 @@ HAS_ACTIVITY = hasattr(models, "Activity")
 HAS_REFERRALS = hasattr(models.User, "referral_code")
 HAS_BILLING = hasattr(models.User, "stripe_customer_id")
 HAS_TRIALS = hasattr(models.User, "trial_expiration_date")
+HAS_REDIS = redis_client is not None
 
 
 def require_feature(flag: bool, feature: str) -> None:
     if not flag:
         raise HTTPException(status_code=501, detail=f"{feature} is only available in the Compair Cloud edition.")
 
-def get_current_user(auth_token: str = Header(...)):
+def get_current_user(auth_token: str | None = Header(None)):
+    settings = get_settings_dependency()
+    if not settings.require_authentication:
+        with compair.Session() as session:
+            return _ensure_single_user(session, settings)
+    if not auth_token:
+        raise HTTPException(status_code=401, detail="Missing session token")
     with compair.Session() as session:
         user_session = session.query(models.Session).filter(models.Session.id == auth_token).first()
         if not user_session:
@@ -150,9 +266,20 @@ log_service_resource_metrics(service_name="backend")  # or "frontend"
 
 @router.post("/login")
 def login(request: schema.LoginRequest) -> dict:
+    settings = get_settings_dependency()
     with compair.Session() as session:
+        if not settings.require_authentication:
+            user = _ensure_single_user(session, settings)
+            user_session = _ensure_single_user_session(session, user)
+            return {
+                "user_id": user.user_id,
+                "username": user.username,
+                "name": user.name,
+                "status": user.status,
+                "role": user.role,
+                "auth_token": user_session.id,
+            }
         user = session.query(models.User).filter(models.User.username == request.username).first()
-        print("PW yo: {request.password}")
         if not user or not user.check_password(request.password):
             raise HTTPException(status_code=401, detail="Invalid credentials")
         if user.status == 'inactive':
@@ -526,8 +653,15 @@ def create_user(
 
 
 @router.get("/load_session")
-def load_session(auth_token: str) -> schema.Session | None:
+def load_session(auth_token: str | None = None) -> schema.Session | None:
+    settings = get_settings_dependency()
+    if not settings.require_authentication:
+        with compair.Session() as session:
+            user = _ensure_single_user(session, settings)
+            return _ensure_single_user_session(session, user)
     with compair.Session() as session:
+        if not auth_token:
+            raise HTTPException(status_code=400, detail="auth_token is required when authentication is enabled.")
         user_session = session.query(models.Session).filter(models.Session.id == auth_token).first()
         if not user_session:
             raise HTTPException(status_code=404, detail="Session not found")
@@ -592,6 +726,9 @@ def update_session_duration(
 def delete_user(
     current_user: models.User = Depends(get_current_user)
 ):
+    settings = get_settings_dependency()
+    if not settings.require_authentication:
+        raise HTTPException(status_code=403, detail="Deleting the local user is not supported when authentication is disabled.")
     with compair.Session() as session:
         current_user.delete()
         session.commit()
@@ -1707,6 +1844,9 @@ def load_references(
 
 @router.get("/verify-email")
 def verify_email(token: str):
+    settings = get_settings_dependency()
+    if not settings.require_authentication:
+        raise HTTPException(status_code=403, detail="Email verification is disabled when authentication is disabled.")
     with compair.Session() as session:
         print(token)
         user = session.query(models.User).filter(models.User.verification_token == token).first()
@@ -1765,6 +1905,9 @@ def sign_up(
     request: schema.SignUpRequest,
     analytics: Analytics = Depends(get_analytics),
 ) -> dict:
+    settings = get_settings_dependency()
+    if not settings.require_authentication:
+        raise HTTPException(status_code=403, detail="Sign-up is disabled when authentication is disabled.")
     print('1')
     if not is_valid_email(request.username):
         raise HTTPException(status_code=400, detail="Invalid email address")
@@ -1798,6 +1941,9 @@ def sign_up(
 
 @router.post("/forgot-password")
 def forgot_password(request: schema.ForgotPasswordRequest) -> dict:
+    settings = get_settings_dependency()
+    if not settings.require_authentication:
+        raise HTTPException(status_code=403, detail="Password resets are disabled when authentication is disabled.")
     print('1')
     with compair.Session() as session:
         print('2')
@@ -1830,6 +1976,9 @@ def forgot_password(request: schema.ForgotPasswordRequest) -> dict:
 
 @router.post("/reset-password")
 def reset_password(request: schema.ResetPasswordRequest) -> dict:
+    settings = get_settings_dependency()
+    if not settings.require_authentication:
+        raise HTTPException(status_code=403, detail="Password resets are disabled when authentication is disabled.")
     with compair.Session() as session:
         print('1')
         print(request.token)
@@ -3228,11 +3377,12 @@ def generate_download_token(
         else:
             raise HTTPException(status_code=403, detail="Not authorized to download this file.")
 
+    if not HAS_REDIS:
+        raise HTTPException(status_code=501, detail="Secure download links require Redis, which is unavailable in the core edition.")
+
     token = secrets.token_urlsafe(32)
     key = f"download_token:{token}"
     redis_client.setex(key, 300, document_id)
-    print('Setting redis kv')
-    print(key, document_id)
     return {"download_url": f"/documents/download/{token}"}
 
 
@@ -3241,10 +3391,12 @@ def download_document_with_token(
     token: str,
     storage: StorageProvider = Depends(get_storage),
 ):
+    if not HAS_REDIS:
+        raise HTTPException(status_code=501, detail="Secure download links require Redis, which is unavailable in the core edition.")
+
     key = f"download_token:{token}"
-    print(f'Retrieving redis kv with key {key}')
-    document_id = redis_client.get(key).decode('utf-8') if redis_client.get(key) else None
-    print(f'Value {document_id}')
+    value = redis_client.get(key) if redis_client else None
+    document_id = value.decode('utf-8') if value else None
     if not document_id:
         raise HTTPException(status_code=403, detail="Invalid or expired token")
     redis_client.delete(key)

{compair_core-0.3.9 → compair_core-0.3.11}/compair_core/compair/__init__.py

@@ -1,25 +1,20 @@
 from __future__ import annotations
 
-import importlib
-import logging
 import os
-import sys
-
 from sqlalchemy import Engine, create_engine
 from sqlalchemy.orm import sessionmaker
 
-from ..compair import embeddings, feedback, logger, main, models, tasks, utils
-from ..compair.default_groups import initialize_default_groups
+from . import embeddings, feedback, logger, main, models, tasks, utils
+from .default_groups import initialize_default_groups
 
 edition = os.getenv("COMPAIR_EDITION", "core").lower()
 
-_cloud_available = False
+initialize_database_override = None
+
 if edition == "cloud":
     try:  # Import cloud overrides if the private package is installed
-        from ..compair_cloud import (
+        from compair_cloud import (  # type: ignore
             bootstrap as cloud_bootstrap,
-            celery_app as cloud_celery_app,
-            default_groups as cloud_default_groups,
             embeddings as cloud_embeddings,
             feedback as cloud_feedback,
             logger as cloud_logger,
@@ -27,27 +22,18 @@ if edition == "cloud":
             models as cloud_models,
             tasks as cloud_tasks,
             utils as cloud_utils,
-        )  # type: ignore
+        )
 
-        _cloud_available = True
+        embeddings = cloud_embeddings
+        feedback = cloud_feedback
+        logger = cloud_logger
+        main = cloud_main
+        models = cloud_models
+        tasks = cloud_tasks
+        utils = cloud_utils
+        initialize_database_override = getattr(cloud_bootstrap, "initialize_database", None)
     except ImportError:
-        _cloud_available = False
-
-if _cloud_available:
-    from ..compair_cloud.default_groups import initialize_default_groups  # type: ignore
-    embeddings = cloud_embeddings
-    feedback = cloud_feedback
-    logger = cloud_logger
-    main = cloud_main
-    models = cloud_models
-    tasks = cloud_tasks
-    utils = cloud_utils
-    initialize_database_override = getattr(cloud_bootstrap, "initialize_database", None)
-else:
-    from . import embeddings, feedback, logger, main, models, tasks, utils
-    from .default_groups import initialize_default_groups
-    initialize_database_override = None
-
+        pass
 
 
 def _handle_engine() -> Engine:
@@ -74,15 +60,21 @@ def _handle_engine() -> Engine:
     return create_engine(f"sqlite:///{sqlite_path}", connect_args={"check_same_thread": False})
 
 
-engine = _handle_engine()
-
-
 def initialize_database() -> None:
     models.Base.metadata.create_all(engine)
     if initialize_database_override:
         initialize_database_override(engine)
 
 
-__all__ = ["embeddings", "feedback", "main", "models", "utils"]
-sys.modules.setdefault(__name__ + ".server", importlib.import_module("server"))
-sys.modules.setdefault(__name__ + ".compair_email", importlib.import_module("compair_email"))
+def _initialize_defaults() -> None:
+    with Session() as session:
+        initialize_default_groups(session)
+
+
+engine = _handle_engine()
+Session = sessionmaker(engine)
+embedder = embeddings.Embedder()
+reviewer = feedback.Reviewer()
+_initialize_defaults()
+
+__all__ = ["embeddings", "feedback", "main", "models", "utils", "Session"]

{compair_core-0.3.9 → compair_core-0.3.11}/compair_core/compair/utils.py

@@ -5,7 +5,7 @@ from datetime import datetime, timedelta, timezone
 
 from sqlalchemy.orm import Session
 
-from compair.models import Activity
+from .models import Activity
 
 
 def chunk_text(text: str) -> list[str]:

compair_core-0.3.11/compair_core/compair_email/templates_core.py

@@ -0,0 +1,32 @@
+"""Minimal email templates for the core edition."""
+
+ACCOUNT_VERIFY_TEMPLATE = """
+<p>Hi {{user_name}},</p>
+<p>Please verify your Compair account by clicking the link below:</p>
+<p><a href="{{verify_link}}">Verify my account</a></p>
+<p>Thanks!</p>
+""".strip()
+
+PASSWORD_RESET_TEMPLATE = """
+<p>We received a request to reset your password.</p>
+<p>Your password reset code is: <strong>{{reset_code}}</strong></p>
+""".strip()
+
+GROUP_INVITATION_TEMPLATE = """
+<p>{{inviter_name}} invited you to join the group {{group_name}}.</p>
+<p><a href="{{invitation_link}}">Accept invitation</a></p>
+""".strip()
+
+GROUP_JOIN_TEMPLATE = """
+<p>{{user_name}} has joined your group.</p>
+""".strip()
+
+INDIVIDUAL_INVITATION_TEMPLATE = """
+<p>{{inviter_name}} invited you to Compair.</p>
+<p><a href="{{referral_link}}">Join now</a></p>
+""".strip()
+
+REFERRAL_CREDIT_TEMPLATE = """
+<p>Hi {{user_name}},</p>
+<p>Great news! You now have {{referral_credits}} referral credits.</p>
+""".strip()

{compair_core-0.3.9 → compair_core-0.3.11}/compair_core/server/routers/capabilities.py

@@ -11,10 +11,13 @@ 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": True,
+            "password_login": require_auth,
+            "required": require_auth,
+            "single_user": not require_auth,
         },
         "inputs": {
             "text": True,

{compair_core-0.3.9 → compair_core-0.3.11}/compair_core/server/settings.py

@@ -16,9 +16,12 @@ class Settings(BaseSettings):
     billing_enabled: bool = False
     integrations_enabled: bool = False
     premium_models: bool = False
+    require_authentication: bool = False
+    single_user_username: str = "compair-local@example.com"
+    single_user_name: str = "Compair Local User"
 
     # Core/local storage defaults
-    local_upload_dir: str = "/data/uploads"
+    local_upload_dir: str = "~/.compair-core/data/uploads"
     local_upload_base_url: str = "/uploads"
 
     # Cloud storage (R2/S3-compatible)

{compair_core-0.3.9 → compair_core-0.3.11}/compair_core.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: compair-core
-Version: 0.3.9
+Version: 0.3.11
 Summary: Open-source foundation of the Compair collaboration platform.
 Author: RocketResearch, Inc.
 License: MIT
@@ -23,6 +23,7 @@ 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"
@@ -88,6 +89,8 @@ Key environment variables for the core edition:
 - `COMPAIR_SQLITE_DIR` / `COMPAIR_SQLITE_NAME` – override the default local SQLite path (falls back to `./compair_data` if `/data` is not writable).
 - `COMPAIR_LOCAL_MODEL_URL` – endpoint for your local embeddings/feedback service (defaults to `http://local-model:9000`).
 - `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_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.
 
 See `compair_core/server/settings.py` for the full settings surface.
 

{compair_core-0.3.9 → compair_core-0.3.11}/compair_core.egg-info/requires.txt

@@ -11,6 +11,7 @@ redis>=5.0
 psutil>=5.9
 python-Levenshtein>=0.23
 redmail>=0.6
+python-multipart>=0.0.20
 
 [dev]
 build>=1.0

{compair_core-0.3.9 → compair_core-0.3.11}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "compair-core"
-version = "0.3.9"
+version = "0.3.11"
 description = "Open-source foundation of the Compair collaboration platform."
 readme = "README.md"
 license = { text = "MIT" }
@@ -26,6 +26,7 @@ dependencies = [
   "psutil>=5.9",
   "python-Levenshtein>=0.23",
   "redmail>=0.6",
+  "python-multipart>=0.0.20",
 ]
 
 [project.optional-dependencies]

compair_core-0.3.9/compair_core/compair_email/templates_core.py

@@ -1,13 +0,0 @@
-"""Minimal email templates for the core edition."""
-
-ACCOUNT_VERIFY_TEMPLATE = """
-<p>Hi {{user_name}},</p>
-<p>Please verify your Compair account by clicking the link below:</p>
-<p><a href="{{verify_link}}">Verify my account</a></p>
-<p>Thanks!</p>
-""".strip()
-
-PASSWORD_RESET_TEMPLATE = """
-<p>We received a request to reset your password.</p>
-<p>Your password reset code is: <strong>{{reset_code}}</strong></p>
-""".strip()