syrtis-python-client-internal 1.0.0__tar.gz

syrtis_python_client_internal-1.0.0/PKG-INFO

@@ -0,0 +1,107 @@
+Metadata-Version: 2.1
+Name: syrtis-python-client-internal
+Version: 1.0.0
+Author-Email: weeger <contact@syrtis.ai>
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Requires-Dist: syrtis-python-client>=9.0.0
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Description-Content-Type: text/markdown
+
+# python_client_internal
+
+Version: 1.0.0
+
+## Table of Contents
+
+- [Install](#install)
+- [Tests](#tests)
+- [Roadmap](#roadmap)
+- [Status Compatibility](#status-compatibility)
+- [Useful Links](#useful-links)
+
+## Installation
+
+```bash
+pip install syrtis-python-client-internal
+```
+
+Requires Python >=3.10.
+
+## Tests
+
+This project uses `pytest` for testing and `pytest-cov` for code coverage analysis.
+
+### Installation
+
+First, install the required testing dependencies:
+```bash
+.venv/bin/python -m pip install pytest pytest-cov
+```
+
+### Basic Usage
+
+Run all tests with coverage:
+```bash
+.venv/bin/python -m pytest --cov --cov-report=html
+```
+
+### Common Commands
+```bash
+# Run tests with coverage for a specific module
+.venv/bin/python -m pytest --cov=your_module
+
+# Show which lines are not covered
+.venv/bin/python -m pytest --cov=your_module --cov-report=term-missing
+
+# Generate an HTML coverage report
+.venv/bin/python -m pytest --cov=your_module --cov-report=html
+
+# Combine terminal and HTML reports
+.venv/bin/python -m pytest --cov=your_module --cov-report=term-missing --cov-report=html
+
+# Run specific test file with coverage
+.venv/bin/python -m pytest tests/test_file.py --cov=your_module --cov-report=term-missing
+```
+
+### Viewing HTML Reports
+
+After generating an HTML report, open `htmlcov/index.html` in your browser to view detailed line-by-line coverage information.
+
+### Coverage Threshold
+
+To enforce a minimum coverage percentage:
+```bash
+.venv/bin/python -m pytest --cov=your_module --cov-fail-under=80
+```
+
+This will cause the test suite to fail if coverage drops below 80%.
+
+## Known Limitations & Roadmap
+
+Current limitations and planned features are tracked in the GitHub issues.
+
+See the [project roadmap](https://github.com/wexample/python-python_client_internal/issues) for upcoming features and improvements.
+
+## Status & Compatibility
+
+**Maturity**: Production-ready
+
+**Python Support**: >=3.10
+
+**OS Support**: Linux, macOS, Windows
+
+**Status**: Actively maintained
+
+## Useful Links
+
+- **Homepage**: https://github.com/wexample/python-python-client-internal
+- **Documentation**: [docs.wexample.com](https://docs.wexample.com)
+- **Issue Tracker**: https://github.com/wexample/python-python-client-internal/issues
+- **Discussions**: https://github.com/wexample/python-python-client-internal/discussions
+- **PyPI**: [pypi.org/project/python_client_internal](https://pypi.org/project/python_client_internal/)

syrtis_python_client_internal-1.0.0/README.md

@@ -0,0 +1,92 @@
+# python_client_internal
+
+Version: 1.0.0
+
+## Table of Contents
+
+- [Install](#install)
+- [Tests](#tests)
+- [Roadmap](#roadmap)
+- [Status Compatibility](#status-compatibility)
+- [Useful Links](#useful-links)
+
+## Installation
+
+```bash
+pip install syrtis-python-client-internal
+```
+
+Requires Python >=3.10.
+
+## Tests
+
+This project uses `pytest` for testing and `pytest-cov` for code coverage analysis.
+
+### Installation
+
+First, install the required testing dependencies:
+```bash
+.venv/bin/python -m pip install pytest pytest-cov
+```
+
+### Basic Usage
+
+Run all tests with coverage:
+```bash
+.venv/bin/python -m pytest --cov --cov-report=html
+```
+
+### Common Commands
+```bash
+# Run tests with coverage for a specific module
+.venv/bin/python -m pytest --cov=your_module
+
+# Show which lines are not covered
+.venv/bin/python -m pytest --cov=your_module --cov-report=term-missing
+
+# Generate an HTML coverage report
+.venv/bin/python -m pytest --cov=your_module --cov-report=html
+
+# Combine terminal and HTML reports
+.venv/bin/python -m pytest --cov=your_module --cov-report=term-missing --cov-report=html
+
+# Run specific test file with coverage
+.venv/bin/python -m pytest tests/test_file.py --cov=your_module --cov-report=term-missing
+```
+
+### Viewing HTML Reports
+
+After generating an HTML report, open `htmlcov/index.html` in your browser to view detailed line-by-line coverage information.
+
+### Coverage Threshold
+
+To enforce a minimum coverage percentage:
+```bash
+.venv/bin/python -m pytest --cov=your_module --cov-fail-under=80
+```
+
+This will cause the test suite to fail if coverage drops below 80%.
+
+## Known Limitations & Roadmap
+
+Current limitations and planned features are tracked in the GitHub issues.
+
+See the [project roadmap](https://github.com/wexample/python-python_client_internal/issues) for upcoming features and improvements.
+
+## Status & Compatibility
+
+**Maturity**: Production-ready
+
+**Python Support**: >=3.10
+
+**OS Support**: Linux, macOS, Windows
+
+**Status**: Actively maintained
+
+## Useful Links
+
+- **Homepage**: https://github.com/wexample/python-python-client-internal
+- **Documentation**: [docs.wexample.com](https://docs.wexample.com)
+- **Issue Tracker**: https://github.com/wexample/python-python-client-internal/issues
+- **Discussions**: https://github.com/wexample/python-python-client-internal/discussions
+- **PyPI**: [pypi.org/project/python_client_internal](https://pypi.org/project/python_client_internal/)

syrtis_python_client_internal-1.0.0/pyproject.toml

@@ -0,0 +1,80 @@
+[build-system]
+requires = [
+    "pdm-backend",
+]
+build-backend = "pdm.backend"
+
+[project]
+name = "syrtis-python-client-internal"
+version = "1.0.0"
+authors = [
+    { name = "weeger", email = "contact@syrtis.ai" },
+]
+requires-python = ">=3.10"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "syrtis-python-client>=9.0.0",
+]
+
+[project.readme]
+file = "README.md"
+content-type = "text/markdown"
+
+[project.license]
+text = "MIT"
+
+[project.optional-dependencies]
+dev = [
+    "pytest",
+    "pytest-cov",
+]
+
+[tool.setuptools.packages.find]
+include = [
+    "*",
+]
+exclude = [
+    "syrtis_python_client_internal.testing*",
+]
+
+[tool.pdm]
+distribution = true
+
+[tool.pdm.build]
+package-dir = "src"
+packages = [
+    { include = "syrtis_python_client_internal", from = "src" },
+]
+
+[tool.pytest.ini_options]
+testpaths = [
+    "tests",
+]
+pythonpath = [
+    "src",
+]
+
+[tool.coverage.run]
+source = [
+    "syrtis_python_client_internal",
+]
+omit = [
+    "*/tests/*",
+    "*/.venv/*",
+    "*/venv/*",
+]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if __name__ == .__main__.:",
+    "if TYPE_CHECKING:",
+    "@abstractmethod",
+]

syrtis_python_client_internal-1.0.0/src/syrtis_python_client_internal/__init__.py

@@ -0,0 +1,17 @@
+from __future__ import annotations
+
+from syrtis_python_client_internal.common.syrtis_client import SyrtisClient
+from syrtis_python_client_internal.database.database_repositories_manager import (
+    DatabaseRepositoriesManager,
+)
+from syrtis_python_client_internal.entity.internal_sample import InternalSample
+from syrtis_python_client_internal.repository.internal_sample_repository import (
+    InternalSampleRepository,
+)
+
+__all__ = [
+    "DatabaseRepositoriesManager",
+    "SyrtisClient",
+    "InternalSample",
+    "InternalSampleRepository",
+]

syrtis_python_client_internal-1.0.0/src/syrtis_python_client_internal/common/entity_schemas.py

@@ -0,0 +1,11 @@
+from __future__ import annotations
+
+from typing import Any
+
+from syrtis_python_client_internal.common.generated_entity_schemas import (
+    get_generated_entity_schemas,
+)
+
+
+def get_entity_schemas() -> dict[str, dict[str, Any]]:
+    return get_generated_entity_schemas()

syrtis_python_client_internal-1.0.0/src/syrtis_python_client_internal/common/generated_entities.py

@@ -0,0 +1,83 @@
+from __future__ import annotations
+
+from syrtis_python_client.common.generated_entities import (
+    generated_entities as external_generated_entities,
+)
+from syrtis_python_client_internal.entity.artifact import Artifact
+from syrtis_python_client_internal.entity.content_type import ContentType
+from syrtis_python_client_internal.entity.credential import Credential
+from syrtis_python_client_internal.entity.credential_parameter import CredentialParameter
+from syrtis_python_client_internal.entity.dashboard import Dashboard
+from syrtis_python_client_internal.entity.directory import Directory
+from syrtis_python_client_internal.entity.document_directory import DocumentDirectory
+from syrtis_python_client_internal.entity.embedding import Embedding
+from syrtis_python_client_internal.entity.extension import Extension
+from syrtis_python_client_internal.entity.instruction import Instruction
+from syrtis_python_client_internal.entity.internal_sample import InternalSample
+from syrtis_python_client_internal.entity.layer import Layer
+from syrtis_python_client_internal.entity.log import Log
+from syrtis_python_client_internal.entity.model import Model
+from syrtis_python_client_internal.entity.operator import Operator
+from syrtis_python_client_internal.entity.operator_port import OperatorPort
+from syrtis_python_client_internal.entity.panel import Panel
+from syrtis_python_client_internal.entity.panel_stamp import PanelStamp
+from syrtis_python_client_internal.entity.pipeline import Pipeline
+from syrtis_python_client_internal.entity.pipeline_operator import PipelineOperator
+from syrtis_python_client_internal.entity.pipeline_projection import PipelineProjection
+from syrtis_python_client_internal.entity.project import Project
+from syrtis_python_client_internal.entity.project_access import ProjectAccess
+from syrtis_python_client_internal.entity.projection import Projection
+from syrtis_python_client_internal.entity.projection_config import ProjectionConfig
+from syrtis_python_client_internal.entity.projection_relation import ProjectionRelation
+from syrtis_python_client_internal.entity.prompt import Prompt
+from syrtis_python_client_internal.entity.schema import Schema
+from syrtis_python_client_internal.entity.session_group import SessionGroup
+from syrtis_python_client_internal.entity.source import Source
+from syrtis_python_client_internal.entity.storage import Storage
+from syrtis_python_client_internal.entity.storage_content_type import StorageContentType
+from syrtis_python_client_internal.entity.token import Token
+from syrtis_python_client_internal.entity.trigger import Trigger
+from syrtis_python_client_internal.entity.trigger_config import TriggerConfig
+from syrtis_python_client_internal.entity.user_config import UserConfig
+from syrtis_python_client_internal.common import generated_external_relations  # noqa: F401
+
+
+generated_entities = [
+    Artifact,
+    ContentType,
+    Credential,
+    CredentialParameter,
+    Dashboard,
+    Directory,
+    DocumentDirectory,
+    Embedding,
+    Extension,
+    Instruction,
+    InternalSample,
+    Layer,
+    Log,
+    Model,
+    Operator,
+    OperatorPort,
+    Panel,
+    PanelStamp,
+    Pipeline,
+    PipelineOperator,
+    PipelineProjection,
+    Project,
+    ProjectAccess,
+    Projection,
+    ProjectionConfig,
+    ProjectionRelation,
+    Prompt,
+    Schema,
+    SessionGroup,
+    Source,
+    Storage,
+    StorageContentType,
+    Token,
+    Trigger,
+    TriggerConfig,
+    UserConfig,
+]
+all_entities = [*external_generated_entities, *generated_entities]

syrtis_python_client_internal-1.0.0/src/syrtis_python_client_internal/common/generated_entity_schemas.py

@@ -0,0 +1,54 @@
+from __future__ import annotations
+
+import json
+from importlib.resources import files
+from typing import Any
+
+ENTITY_SCHEMA_FILES = [
+    "artifact.json",
+    "content_type.json",
+    "credential.json",
+    "credential_parameter.json",
+    "dashboard.json",
+    "directory.json",
+    "document_directory.json",
+    "embedding.json",
+    "extension.json",
+    "instruction.json",
+    "internal_sample.json",
+    "layer.json",
+    "log.json",
+    "model.json",
+    "operator.json",
+    "operator_port.json",
+    "panel.json",
+    "panel_stamp.json",
+    "pipeline.json",
+    "pipeline_operator.json",
+    "pipeline_projection.json",
+    "project.json",
+    "project_access.json",
+    "projection.json",
+    "projection_config.json",
+    "projection_relation.json",
+    "prompt.json",
+    "schema.json",
+    "session_group.json",
+    "source.json",
+    "storage.json",
+    "storage_content_type.json",
+    "token.json",
+    "trigger.json",
+    "trigger_config.json",
+    "user_config.json",
+]
+
+
+def get_generated_entity_schemas() -> dict[str, dict[str, Any]]:
+    data_package = "syrtis_python_client_internal.data.entity"
+    schemas: dict[str, dict[str, Any]] = {}
+    for file_name in ENTITY_SCHEMA_FILES:
+        schema_file = files(data_package).joinpath(file_name)
+        schema = json.loads(schema_file.read_text(encoding="utf-8"))
+        schemas[schema["name"]] = schema
+    return schemas

syrtis_python_client_internal-1.0.0/src/syrtis_python_client_internal/common/generated_external_relations.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+from sqlalchemy.orm import relationship
+from syrtis_python_client.entity.chunk import Chunk
+from syrtis_python_client.entity.document import Document
+from syrtis_python_client.entity.message import Message
+from syrtis_python_client.entity.request import Request
+from syrtis_python_client.entity.scenario import Scenario
+from syrtis_python_client.entity.session import Session
+
+
+Chunk.embeddings = relationship('Embedding', primaryjoin='Chunk.id == foreign(Embedding.chunk_id)', viewonly=True, lazy='select')
+Document.project = relationship('Project', primaryjoin='foreign(Document.project_id) == Project.id', lazy='select')
+Document.documentDirectories = relationship('DocumentDirectory', primaryjoin='Document.id == foreign(DocumentDirectory.document_id)', viewonly=True, lazy='select')
+Message.model = relationship('Model', primaryjoin='foreign(Message.model_id) == Model.id', lazy='select')
+Request.projection = relationship('Projection', primaryjoin='foreign(Request.projection_id) == Projection.id', lazy='select')
+Scenario.project = relationship('Project', primaryjoin='foreign(Scenario.project_id) == Project.id', lazy='select')
+Session.sessionGroup = relationship('SessionGroup', primaryjoin='foreign(Session.session_group_id) == SessionGroup.id', lazy='select')

syrtis_python_client_internal-1.0.0/src/syrtis_python_client_internal/common/generated_repositories.py

@@ -0,0 +1,76 @@
+from syrtis_python_client_internal.repository.artifact_repository import ArtifactRepository
+from syrtis_python_client_internal.repository.content_type_repository import ContentTypeRepository
+from syrtis_python_client_internal.repository.credential_parameter_repository import CredentialParameterRepository
+from syrtis_python_client_internal.repository.credential_repository import CredentialRepository
+from syrtis_python_client_internal.repository.dashboard_repository import DashboardRepository
+from syrtis_python_client_internal.repository.directory_repository import DirectoryRepository
+from syrtis_python_client_internal.repository.document_directory_repository import DocumentDirectoryRepository
+from syrtis_python_client_internal.repository.embedding_repository import EmbeddingRepository
+from syrtis_python_client_internal.repository.extension_repository import ExtensionRepository
+from syrtis_python_client_internal.repository.instruction_repository import InstructionRepository
+from syrtis_python_client_internal.repository.internal_sample_repository import InternalSampleRepository
+from syrtis_python_client_internal.repository.layer_repository import LayerRepository
+from syrtis_python_client_internal.repository.log_repository import LogRepository
+from syrtis_python_client_internal.repository.model_repository import ModelRepository
+from syrtis_python_client_internal.repository.operator_port_repository import OperatorPortRepository
+from syrtis_python_client_internal.repository.operator_repository import OperatorRepository
+from syrtis_python_client_internal.repository.panel_repository import PanelRepository
+from syrtis_python_client_internal.repository.panel_stamp_repository import PanelStampRepository
+from syrtis_python_client_internal.repository.pipeline_operator_repository import PipelineOperatorRepository
+from syrtis_python_client_internal.repository.pipeline_projection_repository import PipelineProjectionRepository
+from syrtis_python_client_internal.repository.pipeline_repository import PipelineRepository
+from syrtis_python_client_internal.repository.project_access_repository import ProjectAccessRepository
+from syrtis_python_client_internal.repository.project_repository import ProjectRepository
+from syrtis_python_client_internal.repository.projection_config_repository import ProjectionConfigRepository
+from syrtis_python_client_internal.repository.projection_relation_repository import ProjectionRelationRepository
+from syrtis_python_client_internal.repository.projection_repository import ProjectionRepository
+from syrtis_python_client_internal.repository.prompt_repository import PromptRepository
+from syrtis_python_client_internal.repository.schema_repository import SchemaRepository
+from syrtis_python_client_internal.repository.session_group_repository import SessionGroupRepository
+from syrtis_python_client_internal.repository.source_repository import SourceRepository
+from syrtis_python_client_internal.repository.storage_content_type_repository import StorageContentTypeRepository
+from syrtis_python_client_internal.repository.storage_repository import StorageRepository
+from syrtis_python_client_internal.repository.token_repository import TokenRepository
+from syrtis_python_client_internal.repository.trigger_config_repository import TriggerConfigRepository
+from syrtis_python_client_internal.repository.trigger_repository import TriggerRepository
+from syrtis_python_client_internal.repository.user_config_repository import UserConfigRepository
+
+
+generated_repositories = [
+    ArtifactRepository,
+    ContentTypeRepository,
+    CredentialParameterRepository,
+    CredentialRepository,
+    DashboardRepository,
+    DirectoryRepository,
+    DocumentDirectoryRepository,
+    EmbeddingRepository,
+    ExtensionRepository,
+    InstructionRepository,
+    InternalSampleRepository,
+    LayerRepository,
+    LogRepository,
+    ModelRepository,
+    OperatorPortRepository,
+    OperatorRepository,
+    PanelRepository,
+    PanelStampRepository,
+    PipelineOperatorRepository,
+    PipelineProjectionRepository,
+    PipelineRepository,
+    ProjectAccessRepository,
+    ProjectRepository,
+    ProjectionConfigRepository,
+    ProjectionRelationRepository,
+    ProjectionRepository,
+    PromptRepository,
+    SchemaRepository,
+    SessionGroupRepository,
+    SourceRepository,
+    StorageContentTypeRepository,
+    StorageRepository,
+    TokenRepository,
+    TriggerConfigRepository,
+    TriggerRepository,
+    UserConfigRepository,
+]

syrtis_python_client_internal-1.0.0/src/syrtis_python_client_internal/common/syrtis_client.py

@@ -0,0 +1,31 @@
+from __future__ import annotations
+
+from typing import Any
+
+from syrtis_python_client.common.syrtis_client import SyrtisClient as SyrtisClientPublic
+
+from syrtis_python_client_internal.common.entity_schemas import get_entity_schemas
+from syrtis_python_client_internal.common.generated_repositories import (
+    generated_repositories,
+)
+
+
+class SyrtisClient(SyrtisClientPublic):
+    def get_entity_schemas(self) -> dict[str, dict[str, Any]]:
+        return {
+            **super().get_entity_schemas(),
+            **get_entity_schemas(),
+        }
+
+    def get_repository_classes(self) -> list[type[Any]]:
+        merged = super().get_repository_classes() + list(generated_repositories)
+        unique: list[type[Any]] = []
+        seen: set[type[Any]] = set()
+
+        for repository_class in merged:
+            if repository_class in seen:
+                continue
+            seen.add(repository_class)
+            unique.append(repository_class)
+
+        return unique