syrtis-python-orm 4.0.1__tar.gz

syrtis_python_orm-4.0.1/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.1
+Name: syrtis-python-orm
+Version: 4.0.1
+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: sqlalchemy<3,>=2
+Requires-Dist: wexample-orm>=0.0.2
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Description-Content-Type: text/markdown
+
+# python_orm
+
+Version: 4.0.1
+
+## Table of Contents
+
+- [Install](#install)
+- [Tests](#tests)
+- [Roadmap](#roadmap)
+- [Status Compatibility](#status-compatibility)
+- [Useful Links](#useful-links)
+
+## Installation
+
+```bash
+pip install syrtis-python-orm
+```
+
+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_orm/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-orm
+- **Documentation**: [docs.wexample.com](https://docs.wexample.com)
+- **Issue Tracker**: https://github.com/wexample/python-python-orm/issues
+- **Discussions**: https://github.com/wexample/python-python-orm/discussions
+- **PyPI**: [pypi.org/project/python_orm](https://pypi.org/project/python_orm/)

syrtis_python_orm-4.0.1/README.md

@@ -0,0 +1,92 @@
+# python_orm
+
+Version: 4.0.1
+
+## Table of Contents
+
+- [Install](#install)
+- [Tests](#tests)
+- [Roadmap](#roadmap)
+- [Status Compatibility](#status-compatibility)
+- [Useful Links](#useful-links)
+
+## Installation
+
+```bash
+pip install syrtis-python-orm
+```
+
+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_orm/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-orm
+- **Documentation**: [docs.wexample.com](https://docs.wexample.com)
+- **Issue Tracker**: https://github.com/wexample/python-python-orm/issues
+- **Discussions**: https://github.com/wexample/python-python-orm/discussions
+- **PyPI**: [pypi.org/project/python_orm](https://pypi.org/project/python_orm/)

syrtis_python_orm-4.0.1/pyproject.toml

@@ -0,0 +1,81 @@
+[build-system]
+requires = [
+    "pdm-backend",
+]
+build-backend = "pdm.backend"
+
+[project]
+name = "syrtis-python-orm"
+version = "4.0.1"
+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 = [
+    "sqlalchemy>=2,<3",
+    "wexample-orm>=0.0.2",
+]
+
+[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_orm.testing*",
+]
+
+[tool.pdm]
+distribution = true
+
+[tool.pdm.build]
+package-dir = "src"
+packages = [
+    { include = "syrtis_python_orm", from = "src" },
+]
+
+[tool.pytest.ini_options]
+testpaths = [
+    "tests",
+]
+pythonpath = [
+    "src",
+]
+
+[tool.coverage.run]
+source = [
+    "syrtis_python_orm",
+]
+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_orm-4.0.1/src/syrtis_python_orm/__init__.py

@@ -0,0 +1,7 @@
+from __future__ import annotations
+
+from syrtis_python_orm.common.orm_repositories_manager import OrmRepositoriesManager
+
+__all__ = [
+    "OrmRepositoriesManager",
+]

syrtis_python_orm-4.0.1/src/syrtis_python_orm/common/generated_entities.py

@@ -0,0 +1,117 @@
+from __future__ import annotations
+
+from syrtis_python_orm.entity.artifact import Artifact
+from syrtis_python_orm.entity.card import Card
+from syrtis_python_orm.entity.card_message import CardMessage
+from syrtis_python_orm.entity.card_relation import CardRelation
+from syrtis_python_orm.entity.chunk import Chunk
+from syrtis_python_orm.entity.content_type import ContentType
+from syrtis_python_orm.entity.credential import Credential
+from syrtis_python_orm.entity.credential_parameter import CredentialParameter
+from syrtis_python_orm.entity.dashboard import Dashboard
+from syrtis_python_orm.entity.directory import Directory
+from syrtis_python_orm.entity.document import Document
+from syrtis_python_orm.entity.document_directory import DocumentDirectory
+from syrtis_python_orm.entity.embedding import Embedding
+from syrtis_python_orm.entity.environment import Environment
+from syrtis_python_orm.entity.extension import Extension
+from syrtis_python_orm.entity.instruction import Instruction
+from syrtis_python_orm.entity.job import Job
+from syrtis_python_orm.entity.layer import Layer
+from syrtis_python_orm.entity.log import Log
+from syrtis_python_orm.entity.message import Message
+from syrtis_python_orm.entity.message_stamp import MessageStamp
+from syrtis_python_orm.entity.model import Model
+from syrtis_python_orm.entity.node import Node
+from syrtis_python_orm.entity.operator import Operator
+from syrtis_python_orm.entity.operator_port import OperatorPort
+from syrtis_python_orm.entity.panel import Panel
+from syrtis_python_orm.entity.panel_stamp import PanelStamp
+from syrtis_python_orm.entity.pipeline import Pipeline
+from syrtis_python_orm.entity.pipeline_operator import PipelineOperator
+from syrtis_python_orm.entity.pipeline_projection import PipelineProjection
+from syrtis_python_orm.entity.project import Project
+from syrtis_python_orm.entity.project_access import ProjectAccess
+from syrtis_python_orm.entity.projection import Projection
+from syrtis_python_orm.entity.projection_config import ProjectionConfig
+from syrtis_python_orm.entity.projection_relation import ProjectionRelation
+from syrtis_python_orm.entity.prompt import Prompt
+from syrtis_python_orm.entity.request import Request
+from syrtis_python_orm.entity.scenario import Scenario
+from syrtis_python_orm.entity.schema import Schema
+from syrtis_python_orm.entity.session import Session
+from syrtis_python_orm.entity.session_group import SessionGroup
+from syrtis_python_orm.entity.slot import Slot
+from syrtis_python_orm.entity.slot_config import SlotConfig
+from syrtis_python_orm.entity.slot_message import SlotMessage
+from syrtis_python_orm.entity.slot_message_stamp import SlotMessageStamp
+from syrtis_python_orm.entity.slot_relation import SlotRelation
+from syrtis_python_orm.entity.source import Source
+from syrtis_python_orm.entity.storage import Storage
+from syrtis_python_orm.entity.storage_content_type import StorageContentType
+from syrtis_python_orm.entity.template import Template
+from syrtis_python_orm.entity.timezone import Timezone
+from syrtis_python_orm.entity.token import Token
+from syrtis_python_orm.entity.trigger import Trigger
+from syrtis_python_orm.entity.trigger_config import TriggerConfig
+from syrtis_python_orm.entity.user import User
+from syrtis_python_orm.entity.user_config import UserConfig
+
+generated_entities = [
+    Artifact,
+    Card,
+    CardMessage,
+    CardRelation,
+    Chunk,
+    ContentType,
+    Credential,
+    CredentialParameter,
+    Dashboard,
+    Directory,
+    Document,
+    DocumentDirectory,
+    Embedding,
+    Environment,
+    Extension,
+    Instruction,
+    Job,
+    Layer,
+    Log,
+    Message,
+    MessageStamp,
+    Model,
+    Node,
+    Operator,
+    OperatorPort,
+    Panel,
+    PanelStamp,
+    Pipeline,
+    PipelineOperator,
+    PipelineProjection,
+    Project,
+    ProjectAccess,
+    Projection,
+    ProjectionConfig,
+    ProjectionRelation,
+    Prompt,
+    Request,
+    Scenario,
+    Schema,
+    Session,
+    SessionGroup,
+    Slot,
+    SlotConfig,
+    SlotMessage,
+    SlotMessageStamp,
+    SlotRelation,
+    Source,
+    Storage,
+    StorageContentType,
+    Template,
+    Timezone,
+    Token,
+    Trigger,
+    TriggerConfig,
+    User,
+    UserConfig,
+]

syrtis_python_orm-4.0.1/src/syrtis_python_orm/common/generated_repositories.py

@@ -0,0 +1,137 @@
+from __future__ import annotations
+
+from syrtis_python_orm.repository.artifact_repository import ArtifactRepository
+from syrtis_python_orm.repository.card_message_repository import CardMessageRepository
+from syrtis_python_orm.repository.card_relation_repository import CardRelationRepository
+from syrtis_python_orm.repository.card_repository import CardRepository
+from syrtis_python_orm.repository.chunk_repository import ChunkRepository
+from syrtis_python_orm.repository.content_type_repository import ContentTypeRepository
+from syrtis_python_orm.repository.credential_parameter_repository import (
+    CredentialParameterRepository,
+)
+from syrtis_python_orm.repository.credential_repository import CredentialRepository
+from syrtis_python_orm.repository.dashboard_repository import DashboardRepository
+from syrtis_python_orm.repository.directory_repository import DirectoryRepository
+from syrtis_python_orm.repository.document_directory_repository import (
+    DocumentDirectoryRepository,
+)
+from syrtis_python_orm.repository.document_repository import DocumentRepository
+from syrtis_python_orm.repository.embedding_repository import EmbeddingRepository
+from syrtis_python_orm.repository.environment_repository import EnvironmentRepository
+from syrtis_python_orm.repository.extension_repository import ExtensionRepository
+from syrtis_python_orm.repository.instruction_repository import InstructionRepository
+from syrtis_python_orm.repository.job_repository import JobRepository
+from syrtis_python_orm.repository.layer_repository import LayerRepository
+from syrtis_python_orm.repository.log_repository import LogRepository
+from syrtis_python_orm.repository.message_repository import MessageRepository
+from syrtis_python_orm.repository.message_stamp_repository import MessageStampRepository
+from syrtis_python_orm.repository.model_repository import ModelRepository
+from syrtis_python_orm.repository.node_repository import NodeRepository
+from syrtis_python_orm.repository.operator_port_repository import OperatorPortRepository
+from syrtis_python_orm.repository.operator_repository import OperatorRepository
+from syrtis_python_orm.repository.panel_repository import PanelRepository
+from syrtis_python_orm.repository.panel_stamp_repository import PanelStampRepository
+from syrtis_python_orm.repository.pipeline_operator_repository import (
+    PipelineOperatorRepository,
+)
+from syrtis_python_orm.repository.pipeline_projection_repository import (
+    PipelineProjectionRepository,
+)
+from syrtis_python_orm.repository.pipeline_repository import PipelineRepository
+from syrtis_python_orm.repository.project_access_repository import (
+    ProjectAccessRepository,
+)
+from syrtis_python_orm.repository.project_repository import ProjectRepository
+from syrtis_python_orm.repository.projection_config_repository import (
+    ProjectionConfigRepository,
+)
+from syrtis_python_orm.repository.projection_relation_repository import (
+    ProjectionRelationRepository,
+)
+from syrtis_python_orm.repository.projection_repository import ProjectionRepository
+from syrtis_python_orm.repository.prompt_repository import PromptRepository
+from syrtis_python_orm.repository.request_repository import RequestRepository
+from syrtis_python_orm.repository.scenario_repository import ScenarioRepository
+from syrtis_python_orm.repository.schema_repository import SchemaRepository
+from syrtis_python_orm.repository.session_group_repository import SessionGroupRepository
+from syrtis_python_orm.repository.session_repository import SessionRepository
+from syrtis_python_orm.repository.slot_config_repository import SlotConfigRepository
+from syrtis_python_orm.repository.slot_message_repository import SlotMessageRepository
+from syrtis_python_orm.repository.slot_message_stamp_repository import (
+    SlotMessageStampRepository,
+)
+from syrtis_python_orm.repository.slot_relation_repository import SlotRelationRepository
+from syrtis_python_orm.repository.slot_repository import SlotRepository
+from syrtis_python_orm.repository.source_repository import SourceRepository
+from syrtis_python_orm.repository.storage_content_type_repository import (
+    StorageContentTypeRepository,
+)
+from syrtis_python_orm.repository.storage_repository import StorageRepository
+from syrtis_python_orm.repository.template_repository import TemplateRepository
+from syrtis_python_orm.repository.timezone_repository import TimezoneRepository
+from syrtis_python_orm.repository.token_repository import TokenRepository
+from syrtis_python_orm.repository.trigger_config_repository import (
+    TriggerConfigRepository,
+)
+from syrtis_python_orm.repository.trigger_repository import TriggerRepository
+from syrtis_python_orm.repository.user_config_repository import UserConfigRepository
+from syrtis_python_orm.repository.user_repository import UserRepository
+
+generated_repositories = [
+    ArtifactRepository,
+    CardMessageRepository,
+    CardRelationRepository,
+    CardRepository,
+    ChunkRepository,
+    ContentTypeRepository,
+    CredentialParameterRepository,
+    CredentialRepository,
+    DashboardRepository,
+    DirectoryRepository,
+    DocumentDirectoryRepository,
+    DocumentRepository,
+    EmbeddingRepository,
+    EnvironmentRepository,
+    ExtensionRepository,
+    InstructionRepository,
+    JobRepository,
+    LayerRepository,
+    LogRepository,
+    MessageRepository,
+    MessageStampRepository,
+    ModelRepository,
+    NodeRepository,
+    OperatorPortRepository,
+    OperatorRepository,
+    PanelRepository,
+    PanelStampRepository,
+    PipelineOperatorRepository,
+    PipelineProjectionRepository,
+    PipelineRepository,
+    ProjectAccessRepository,
+    ProjectRepository,
+    ProjectionConfigRepository,
+    ProjectionRelationRepository,
+    ProjectionRepository,
+    PromptRepository,
+    RequestRepository,
+    ScenarioRepository,
+    SchemaRepository,
+    SessionGroupRepository,
+    SessionRepository,
+    SlotConfigRepository,
+    SlotMessageRepository,
+    SlotMessageStampRepository,
+    SlotRelationRepository,
+    SlotRepository,
+    SourceRepository,
+    StorageContentTypeRepository,
+    StorageRepository,
+    TemplateRepository,
+    TimezoneRepository,
+    TokenRepository,
+    TriggerConfigRepository,
+    TriggerRepository,
+    UserConfigRepository,
+    UserRepository,
+]

syrtis_python_orm-4.0.1/src/syrtis_python_orm/common/orm_repositories_manager.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+from wexample_helpers.decorator.base_class import base_class
+from wexample_orm.common.abstract_repositories_manager import (
+    AbstractRepositoriesManager,
+)
+
+
+@base_class
+class OrmRepositoriesManager(AbstractRepositoriesManager):
+    """Syrtis-flavored repositories manager.
+
+    Inherits all behavior (get / get_by_table_name / get_classes) from
+    `wexample_orm.AbstractRepositoriesManager`. Only extra responsibility:
+    auto-load `generated_repositories` when the caller doesn't provide a list.
+    """
+
+    def __attrs_post_init__(self) -> None:
+        if not self.repository_classes:
+            from syrtis_python_orm.common.generated_repositories import (
+                generated_repositories,
+            )
+
+            self.repository_classes = list(generated_repositories)