wexample-wex-addon-services-db 0.0.3__tar.gz

wexample_wex_addon_services_db-0.0.3/PKG-INFO

@@ -0,0 +1,164 @@
+Metadata-Version: 2.1
+Name: wexample-wex-addon-services-db
+Version: 0.0.3
+Summary: Database services (mysql, postgres...) for wex
+Author-Email: weeger <contact@wexample.com>
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Requires-Dist: wexample-wex-addon-app>=1.0.0
+Requires-Dist: wexample-wex-core>=7.0.0
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Description-Content-Type: text/markdown
+
+# wex_addon_services_db
+
+Version: 0.0.3
+
+Database services (mysql, postgres...) for wex
+
+## Table of Contents
+
+- [Tests](#tests)
+- [Suite Integration](#suite-integration)
+- [Dependencies](#dependencies)
+- [Versioning](#versioning)
+- [License](#license)
+- [Suite Integration](#suite-integration)
+- [Suite Signature](#suite-signature)
+- [Roadmap](#roadmap)
+- [Status Compatibility](#status-compatibility)
+- [Useful Links](#useful-links)
+- [Migration Notes](#migration-notes)
+
+## 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%.
+
+## Integration in the Suite
+
+This package is part of the Wexample Suite — a collection of high-quality, modular tools designed to work seamlessly together across multiple languages and environments.
+
+### Related Packages
+
+The suite includes packages for configuration management, file handling, prompts, and more. Each package can be used independently or as part of the integrated suite.
+
+Visit the [Wexample Suite documentation](https://docs.wexample.com) for the complete package ecosystem.
+
+## Dependencies
+
+- wexample-wex-addon-app: >=1.0.0
+- wexample-wex-core: >=7.0.0
+
+## Versioning & Compatibility Policy
+
+Wexample packages follow **Semantic Versioning** (SemVer):
+
+- **MAJOR**: Breaking changes
+- **MINOR**: New features, backward compatible
+- **PATCH**: Bug fixes, backward compatible
+
+We maintain backward compatibility within major versions and provide clear migration guides for breaking changes.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+Free to use in both personal and commercial projects.
+
+## Integration in the Suite
+
+This package is part of the Wexample Suite — a collection of high-quality, modular tools designed to work seamlessly together across multiple languages and environments.
+
+### Related Packages
+
+The suite includes packages for configuration management, file handling, prompts, and more. Each package can be used independently or as part of the integrated suite.
+
+Visit the [Wexample Suite documentation](https://docs.wexample.com) for the complete package ecosystem.
+
+# About us
+
+[Wexample](https://wexample.com) stands as a cornerstone of the digital ecosystem — a collective of seasoned engineers, researchers, and creators driven by a relentless pursuit of technological excellence. More than a media platform, it has grown into a vibrant community where innovation meets craftsmanship, and where every line of code reflects a commitment to clarity, durability, and shared intelligence.
+
+This packages suite embodies this spirit. Trusted by professionals and enthusiasts alike, it delivers a consistent, high-quality foundation for modern development — open, elegant, and battle-tested. Its reputation is built on years of collaboration, refinement, and rigorous attention to detail, making it a natural choice for those who demand both robustness and beauty in their tools.
+
+Wexample cultivates a culture of mastery. Each package, each contribution carries the mark of a community that values precision, ethics, and innovation — a community proud to shape the future of digital craftsmanship.
+
+## Known Limitations & Roadmap
+
+Current limitations and planned features are tracked in the GitHub issues.
+
+See the [project roadmap](https://github.com/wexample/python-wex_addon_services_db/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-wex-addon-services-db
+- **Documentation**: [docs.wexample.com](https://docs.wexample.com)
+- **Issue Tracker**: https://github.com/wexample/python-wex-addon-services-db/issues
+- **Discussions**: https://github.com/wexample/python-wex-addon-services-db/discussions
+- **PyPI**: [pypi.org/project/wex_addon_services_db](https://pypi.org/project/wex_addon_services_db/)
+
+## Migration Notes
+
+When upgrading between major versions, refer to the migration guides in the documentation.
+
+Breaking changes are clearly documented with upgrade paths and examples.

wexample_wex_addon_services_db-0.0.3/README.md

@@ -0,0 +1,147 @@
+# wex_addon_services_db
+
+Version: 0.0.3
+
+Database services (mysql, postgres...) for wex
+
+## Table of Contents
+
+- [Tests](#tests)
+- [Suite Integration](#suite-integration)
+- [Dependencies](#dependencies)
+- [Versioning](#versioning)
+- [License](#license)
+- [Suite Integration](#suite-integration)
+- [Suite Signature](#suite-signature)
+- [Roadmap](#roadmap)
+- [Status Compatibility](#status-compatibility)
+- [Useful Links](#useful-links)
+- [Migration Notes](#migration-notes)
+
+## 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%.
+
+## Integration in the Suite
+
+This package is part of the Wexample Suite — a collection of high-quality, modular tools designed to work seamlessly together across multiple languages and environments.
+
+### Related Packages
+
+The suite includes packages for configuration management, file handling, prompts, and more. Each package can be used independently or as part of the integrated suite.
+
+Visit the [Wexample Suite documentation](https://docs.wexample.com) for the complete package ecosystem.
+
+## Dependencies
+
+- wexample-wex-addon-app: >=1.0.0
+- wexample-wex-core: >=7.0.0
+
+## Versioning & Compatibility Policy
+
+Wexample packages follow **Semantic Versioning** (SemVer):
+
+- **MAJOR**: Breaking changes
+- **MINOR**: New features, backward compatible
+- **PATCH**: Bug fixes, backward compatible
+
+We maintain backward compatibility within major versions and provide clear migration guides for breaking changes.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+Free to use in both personal and commercial projects.
+
+## Integration in the Suite
+
+This package is part of the Wexample Suite — a collection of high-quality, modular tools designed to work seamlessly together across multiple languages and environments.
+
+### Related Packages
+
+The suite includes packages for configuration management, file handling, prompts, and more. Each package can be used independently or as part of the integrated suite.
+
+Visit the [Wexample Suite documentation](https://docs.wexample.com) for the complete package ecosystem.
+
+# About us
+
+[Wexample](https://wexample.com) stands as a cornerstone of the digital ecosystem — a collective of seasoned engineers, researchers, and creators driven by a relentless pursuit of technological excellence. More than a media platform, it has grown into a vibrant community where innovation meets craftsmanship, and where every line of code reflects a commitment to clarity, durability, and shared intelligence.
+
+This packages suite embodies this spirit. Trusted by professionals and enthusiasts alike, it delivers a consistent, high-quality foundation for modern development — open, elegant, and battle-tested. Its reputation is built on years of collaboration, refinement, and rigorous attention to detail, making it a natural choice for those who demand both robustness and beauty in their tools.
+
+Wexample cultivates a culture of mastery. Each package, each contribution carries the mark of a community that values precision, ethics, and innovation — a community proud to shape the future of digital craftsmanship.
+
+## Known Limitations & Roadmap
+
+Current limitations and planned features are tracked in the GitHub issues.
+
+See the [project roadmap](https://github.com/wexample/python-wex_addon_services_db/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-wex-addon-services-db
+- **Documentation**: [docs.wexample.com](https://docs.wexample.com)
+- **Issue Tracker**: https://github.com/wexample/python-wex-addon-services-db/issues
+- **Discussions**: https://github.com/wexample/python-wex-addon-services-db/discussions
+- **PyPI**: [pypi.org/project/wex_addon_services_db](https://pypi.org/project/wex_addon_services_db/)
+
+## Migration Notes
+
+When upgrading between major versions, refer to the migration guides in the documentation.
+
+Breaking changes are clearly documented with upgrade paths and examples.

wexample_wex_addon_services_db-0.0.3/pyproject.toml

@@ -0,0 +1,82 @@
+[build-system]
+requires = [
+    "pdm-backend",
+]
+build-backend = "pdm.backend"
+
+[project]
+name = "wexample-wex-addon-services-db"
+version = "0.0.3"
+description = "Database services (mysql, postgres...) for wex"
+authors = [
+    { name = "weeger", email = "contact@wexample.com" },
+]
+requires-python = ">=3.10"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "wexample-wex-addon-app>=1.0.0",
+    "wexample-wex-core>=7.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 = [
+    "wexample_wex_addon_services_db.testing*",
+]
+
+[tool.pdm]
+distribution = true
+
+[tool.pdm.build]
+package-dir = "src"
+packages = [
+    { include = "wexample_wex_addon_services_db", from = "src" },
+]
+
+[tool.pytest.ini_options]
+pythonpath = [
+    "src",
+]
+testpaths = [
+    "tests",
+]
+
+[tool.coverage.run]
+source = [
+    "wexample_wex_addon_services_db",
+]
+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",
+]

wexample_wex_addon_services_db-0.0.3/src/wexample_wex_addon_services_db/__init__.py

@@ -0,0 +1,7 @@
+from __future__ import annotations
+
+from wexample_wex_addon_services_db.services_db_addon_manager import (
+    ServicesDbAddonManager,
+)
+
+__all__ = ["ServicesDbAddonManager"]

wexample_wex_addon_services_db-0.0.3/src/wexample_wex_addon_services_db/services/elasticsearch/app_service.py

@@ -0,0 +1,29 @@
+from __future__ import annotations
+
+from wexample_wex_addon_app.service.app_service import AppService as BaseAppService
+
+
+class AppService(BaseAppService):
+    def get_workdir_contribution(self) -> dict:
+        from wexample_filestate.const.disk import DiskItemType
+
+        # Elasticsearch container runs as uid 1000 (elasticsearch user)
+        es_mode = {"owner": "1000:1000", "permissions": "750", "recursive": True}
+
+        return {
+            "children": [
+                {
+                    "name": "elasticsearch",
+                    "type": DiskItemType.DIRECTORY,
+                    "should_exist": True,
+                    "children": [
+                        {
+                            "name": "data",
+                            "type": DiskItemType.DIRECTORY,
+                            "should_exist": True,
+                            "mode": es_mode,
+                        },
+                    ],
+                },
+            ]
+        }

wexample_wex_addon_services_db-0.0.3/src/wexample_wex_addon_services_db/services/elasticsearch/commands/service/install.py

@@ -0,0 +1,31 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from wexample_wex_core.const.globals import COMMAND_TYPE_SERVICE
+from wexample_wex_core.decorator.command import command
+
+if TYPE_CHECKING:
+    from wexample_wex_addon_app.service.app_service import AppService
+    from wexample_wex_core.context.execution_context import ExecutionContext
+
+
+@command(
+    type=COMMAND_TYPE_SERVICE,
+    description="Configure elasticsearch service in app config",
+)
+def elasticsearch__service__install(
+    context: ExecutionContext,
+    service: AppService,
+) -> None:
+    app_name = service.app_workdir.get_config().search("global.name").get_str()
+    config_file = service.app_workdir.get_config_file()
+    config = config_file.read_config()
+
+    config.set_by_path(f"service.{service.name}.host", f"{app_name}_{service.name}")
+    config.set_by_path(f"service.{service.name}.port", 9200)
+
+    config_file.write_config(config)
+    service.app_workdir.get_runtime_config(rebuild=True)
+
+    context.io.log(f"Configured elasticsearch service for app '{app_name}'")

wexample_wex_addon_services_db-0.0.3/src/wexample_wex_addon_services_db/services/elasticsearch/commands/service/ready.py

@@ -0,0 +1,41 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from wexample_wex_core.const.globals import COMMAND_TYPE_SERVICE
+from wexample_wex_core.decorator.command import command
+
+if TYPE_CHECKING:
+    from wexample_app.response.boolean_response import BooleanResponse
+    from wexample_wex_addon_app.service.app_service import AppService
+    from wexample_wex_core.context.execution_context import ExecutionContext
+
+
+@command(
+    type=COMMAND_TYPE_SERVICE, description="Check if elasticsearch service is ready"
+)
+def elasticsearch__service__ready(
+    context: ExecutionContext,
+    service: AppService,
+) -> BooleanResponse:
+    import subprocess
+
+    from wexample_app.response.boolean_response import BooleanResponse
+
+    runtime = service.app_workdir.get_runtime_config()
+    app_project_name = runtime.search("app.project_name").get_str()
+    container_name = f"{app_project_name}_{service.name}"
+
+    result = subprocess.run(
+        [
+            "docker",
+            "exec",
+            container_name,
+            "curl",
+            "-sf",
+            "http://localhost:9200/_cluster/health",
+        ],
+        capture_output=True,
+    )
+
+    return BooleanResponse(kernel=context.kernel, content=result.returncode == 0)

wexample_wex_addon_services_db-0.0.3/src/wexample_wex_addon_services_db/services/elasticsearch/docker/docker-compose.yml

@@ -0,0 +1,27 @@
+services:
+  elasticsearch:
+    container_name: ${APP_PROJECT_NAME}_elasticsearch
+    image: elasticsearch:9.1.4
+    environment:
+      - node.name=elasticsearch
+      - cluster.name=${APP_PROJECT_NAME}-logging
+      - discovery.type=single-node
+      - bootstrap.memory_lock=true
+      - "ES_JAVA_OPTS=-Xms1g -Xmx1g"
+    ulimits:
+      memlock:
+        soft: -1
+        hard: -1
+    volumes:
+      - ${APP_PATH}elasticsearch/data:/usr/share/elasticsearch/data
+    ports:
+      - "9200:9200"
+      - "9300:9300"
+    networks:
+      - wex_net
+    deploy:
+      resources:
+        limits:
+          memory: 6g
+        reservations:
+          memory: 3g

wexample_wex_addon_services_db-0.0.3/src/wexample_wex_addon_services_db/services/elasticsearch/service.yml

@@ -0,0 +1,6 @@
+name: elasticsearch
+tags:
+  - db
+  - search
+docker:
+  compose: docker/docker-compose.yml

wexample_wex_addon_services_db-0.0.3/src/wexample_wex_addon_services_db/services/maria/commands/__init__.py

@@ -0,0 +1 @@
+

wexample_wex_addon_services_db-0.0.3/src/wexample_wex_addon_services_db/services/maria/commands/config/__init__.py

@@ -0,0 +1 @@
+

wexample_wex_addon_services_db-0.0.3/src/wexample_wex_addon_services_db/services/maria/commands/config/runtime.py

@@ -0,0 +1,22 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from wexample_wex_core.const.globals import COMMAND_TYPE_SERVICE
+from wexample_wex_core.decorator.command import command
+
+from wexample_wex_addon_services_db.services.mysql.commands.config.runtime import (
+    mysql__config__runtime,
+)
+
+if TYPE_CHECKING:
+    from wexample_wex_addon_app.service.app_service import AppService
+    from wexample_wex_core.context.execution_context import ExecutionContext
+
+
+@command(type=COMMAND_TYPE_SERVICE, description="Write maria runtime configuration")
+def maria__config__runtime(
+    context: ExecutionContext,
+    service: AppService,
+) -> None:
+    return mysql__config__runtime(context=context, service=service)

wexample_wex_addon_services_db-0.0.3/src/wexample_wex_addon_services_db/services/maria/commands/db/__init__.py

@@ -0,0 +1 @@
+

wexample_wex_addon_services_db-0.0.3/src/wexample_wex_addon_services_db/services/maria/commands/db/connect.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from wexample_wex_core.const.globals import COMMAND_TYPE_SERVICE
+from wexample_wex_core.decorator.command import command
+
+from wexample_wex_addon_services_db.services.mysql.commands.db.connect import (
+    mysql__db__connect,
+)
+
+if TYPE_CHECKING:
+    from wexample_wex_addon_app.service.app_service import AppService
+    from wexample_wex_core.context.execution_context import ExecutionContext
+
+
+@command(
+    type=COMMAND_TYPE_SERVICE, description="Return maria connection arguments string"
+)
+def maria__db__connect(
+    context: ExecutionContext,
+    service: AppService,
+) -> str:
+    return mysql__db__connect(context=context, service=service)

wexample_wex_addon_services_db-0.0.3/src/wexample_wex_addon_services_db/services/maria/commands/db/destroy.py

@@ -0,0 +1,30 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from wexample_wex_core.const.globals import COMMAND_TYPE_SERVICE
+from wexample_wex_core.decorator.command import command
+from wexample_wex_core.decorator.option import option
+
+from wexample_wex_addon_services_db.services.mysql.commands.db.destroy import (
+    mysql__db__destroy,
+)
+
+if TYPE_CHECKING:
+    from wexample_wex_addon_app.service.app_service import AppService
+    from wexample_wex_core.context.execution_context import ExecutionContext
+
+
+@option(
+    name="database",
+    type=str,
+    required=False,
+    description="Database name (defaults to db.main from runtime config)",
+)
+@command(type=COMMAND_TYPE_SERVICE, description="Drop and recreate the maria database")
+def maria__db__destroy(
+    context: ExecutionContext,
+    service: AppService,
+    database: str | None = None,
+) -> None:
+    return mysql__db__destroy(context=context, service=service, database=database)

wexample_wex_addon_services_db-0.0.3/src/wexample_wex_addon_services_db/services/maria/commands/db/dump.py

@@ -0,0 +1,32 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from wexample_wex_core.const.globals import COMMAND_TYPE_SERVICE
+from wexample_wex_core.decorator.command import command
+from wexample_wex_core.decorator.option import option
+
+from wexample_wex_addon_services_db.services.mysql.commands.db.dump import (
+    mysql__db__dump,
+)
+
+if TYPE_CHECKING:
+    from wexample_wex_addon_app.service.app_service import AppService
+    from wexample_wex_core.context.execution_context import ExecutionContext
+
+
+@option(
+    name="file_name",
+    type=str,
+    required=True,
+    description="Dump file name (without extension)",
+)
+@command(
+    type=COMMAND_TYPE_SERVICE, description="Dump the maria database to a .sql file"
+)
+def maria__db__dump(
+    context: ExecutionContext,
+    service: AppService,
+    file_name: str,
+) -> str:
+    return mysql__db__dump(context=context, service=service, file_name=file_name)