wexample-wex-addon-dev-python 0.1.1__py3-none-any.whl → 7.0.0__py3-none-any.whl

wexample_wex_addon_dev_python/resources/.wex.yml

@@ -0,0 +1,2 @@
+filestate:
+  python_init: false

wexample_wex_addon_dev_python/resources/docker/Dockerfile.python-profiling

@@ -0,0 +1,11 @@
+FROM python:3.12-slim
+
+RUN pip install --no-cache-dir pytest pytest-benchmark
+
+# The container runs as the host user (arbitrary UID/GID via docker run --user).
+# Set HOME to /tmp so pip and other tools have a writable directory.
+ENV HOME=/tmp
+
+WORKDIR /app
+
+CMD ["tail", "-f", "/dev/null"]

wexample_wex_addon_dev_python/workdir/mixin/with_profiling_python_workdir_mixin.py

@@ -0,0 +1,93 @@
+from __future__ import annotations
+
+from wexample_wex_addon_app.workdir.mixin.abstract_profiling_workdir_mixin import (
+    AbstractProfilingWorkdirMixin,
+)
+
+
+class WithProfilingPythonWorkdirMixin(AbstractProfilingWorkdirMixin):
+    """Mixin that adds pytest-benchmark profiling capability to a Python workdir.
+
+    Runs benchmarks in the workdir's local venv so that local (unpublished)
+    dependencies are available — no Docker required.
+
+    Requires the workdir to have benchmark tests written with pytest-benchmark:
+        def test_my_function(benchmark):
+            benchmark(my_function, ...)
+    """
+
+    _BENCH_OUTPUT_FILENAME = ".wex_bench.json"
+
+    def run_profiling(self) -> dict:
+        import json
+        import subprocess
+
+        bench_output_path = self.get_path() / self._BENCH_OUTPUT_FILENAME
+        python = self._get_profiling_python()
+
+        bench_result = subprocess.run(
+            [
+                str(python),
+                "-m",
+                "pytest",
+                self.get_benchmark_dir(),
+                "--benchmark-only",
+                f"--benchmark-json={bench_output_path}",
+                "-q",
+            ],
+            capture_output=True,
+            text=True,
+            cwd=str(self.get_path()),
+        )
+
+        if not bench_output_path.exists():
+            return {
+                "error": (
+                    "No benchmark output produced.\n"
+                    f"pytest stdout:\n{bench_result.stdout}\n"
+                    f"pytest stderr:\n{bench_result.stderr}"
+                )
+            }
+
+        try:
+            content = bench_output_path.read_text().strip()
+            if not content:
+                return {
+                    "error": (
+                        "No benchmark tests found. Add tests using pytest-benchmark:\n"
+                        "  def test_my_function(benchmark):\n"
+                        "      benchmark(my_function, ...)"
+                    )
+                }
+            raw = json.loads(content)
+        finally:
+            bench_output_path.unlink(missing_ok=True)
+
+        return self._parse_profiling_output(raw)
+
+    def _get_profiling_python(self) -> Path:
+        import sys
+        from pathlib import Path
+
+        return Path(sys.executable)
+
+    def _parse_profiling_output(self, raw: dict) -> dict:
+        entries = []
+        for bench in raw.get("benchmarks", []):
+            stats = bench.get("stats", {})
+            entries.append(
+                {
+                    "name": bench.get("name"),
+                    "min_ms": round(stats.get("min", 0) * 1000, 3),
+                    "mean_ms": round(stats.get("mean", 0) * 1000, 3),
+                    "median_ms": round(stats.get("median", 0) * 1000, 3),
+                    "max_ms": round(stats.get("max", 0) * 1000, 3),
+                    "rounds": stats.get("rounds", 0),
+                }
+            )
+
+        return {
+            "language": "python",
+            "tool": "pytest-benchmark",
+            "entries": entries,
+        }

wexample_wex_addon_dev_python/workdir/python_package_workdir.py

@@ -25,6 +25,40 @@ if TYPE_CHECKING:
 class PythonPackageWorkdir(PythonWorkdir):
     _project_info_cache = None
 
+    def check_publish_prerequisites(self) -> None:
+        import os
+        import shutil
+
+        super().check_publish_prerequisites()
+        if shutil.which("pdm"):
+            return
+
+        self.warning("'pdm' not found in PATH — required to publish Python packages.")
+        suggestion = (
+            "/home/weeger/.local/bin"
+            if os.path.isfile("/home/weeger/.local/bin/pdm")
+            else None
+        )
+        response = self.io.input(
+            question="Enter the directory containing pdm (will be prepended to PATH):",
+            default_value=suggestion,
+        ).get_value()
+
+        if not response:
+            raise RuntimeError(
+                "'pdm' not configured. Install it with: pipx install pdm"
+            )
+
+        os.environ["PATH"] = response + ":" + os.environ.get("PATH", "")
+        self._persist_env_value("PATH", os.environ["PATH"])
+        self.info(f"Added {response!r} to PATH — saved to .wex/local/env.yml")
+
+        if not shutil.which("pdm"):
+            raise RuntimeError(
+                f"'pdm' still not found after adding {response!r} to PATH. "
+                "Check that pdm is installed in that directory."
+            )
+
     def prepare_value(self, raw_value: DictConfig | None = None) -> DictConfig:
         from wexample_helpers.helpers.array import array_dict_get_by
         from wexample_helpers.helpers.file import file_read

wexample_wex_addon_dev_python/workdir/python_workdir.py

@@ -25,6 +25,9 @@ from wexample_wex_addon_dev_python.const.python import (
     PYTHON_PYTEST_COV_REPORT_DIR,
 )
 from wexample_wex_addon_dev_python.file.python_app_iml_file import PythonAppImlFile
+from wexample_wex_addon_dev_python.workdir.mixin.with_profiling_python_workdir_mixin import (
+    WithProfilingPythonWorkdirMixin,
+)
 
 if TYPE_CHECKING:
     from wexample_config.const.types import DictConfig
@@ -44,7 +47,7 @@ if TYPE_CHECKING:
     )
 
 
-class PythonWorkdir(CodeBaseWorkdir):
+class PythonWorkdir(WithProfilingPythonWorkdirMixin, CodeBaseWorkdir):
     def app_install(self, env: str | None = None, force: bool = False) -> Path:
         from wexample_wex_addon_app.helpers.python import (
             python_ensure_pip_or_fail,

{wexample_wex_addon_dev_python-0.1.1.dist-info → wexample_wex_addon_dev_python-7.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wexample-wex-addon-dev-python
-Version: 0.1.1
+Version: 7.0.0
 Summary: Python dev addon for wex
 Author-Email: weeger <contact@wexample.com>
 License: MIT
@@ -15,8 +15,8 @@ Requires-Dist: griffe>=2.0.2
 Requires-Dist: networkx
 Requires-Dist: pylint
 Requires-Dist: pyright
-Requires-Dist: wexample-filestate-python>=0.1.0
-Requires-Dist: wexample-wex-addon-app>=1.1.0
+Requires-Dist: wexample-filestate-python>=6.4.0
+Requires-Dist: wexample-wex-addon-app>=9.0.0
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
@@ -24,7 +24,132 @@ Description-Content-Type: text/markdown
 
 # wex_addon_dev_python
 
-Version: 0.1.1
+Version: 7.0.0
+
+Python dev addon 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)
+- [Introduction](#introduction)
+- [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
+
+- attrs: >=23.1.0
+- cattrs: >=23.1.0
+- griffe: >=2.0.2
+- networkx: 
+- pylint: 
+- pyright: 
+- wexample-filestate-python: >=6.4.0
+- wexample-wex-addon-app: >=9.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.
+
+# wex_addon_dev_python
+
+Version: 0.2.0
 
 Python dev addon for wex
 
@@ -110,7 +235,7 @@ Visit the [Wexample Suite documentation](https://docs.wexample.com) for the comp
 - pylint: 
 - pyright: 
 - wexample-filestate-python: >=0.1.0
-- wexample-wex-addon-app: >=1.1.0
+- wexample-wex-addon-app: >=1.2.0
 
 ## Versioning & Compatibility Policy
 
@@ -175,3 +300,33 @@ See the [project roadmap](https://github.com/wexample/python-wex_addon_dev_pytho
 When upgrading between major versions, refer to the migration guides in the documentation.
 
 Breaking changes are clearly documented with upgrade paths and examples.
+
+## 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_dev_python/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-dev-python
+- **Documentation**: [docs.wexample.com](https://docs.wexample.com)
+- **Issue Tracker**: https://github.com/wexample/python-wex-addon-dev-python/issues
+- **Discussions**: https://github.com/wexample/python-wex-addon-dev-python/discussions
+- **PyPI**: [pypi.org/project/wex_addon_dev_python](https://pypi.org/project/wex_addon_dev_python/)
+
+## 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_dev_python-0.1.1.dist-info → wexample_wex_addon_dev_python-7.0.0.dist-info}/RECORD

@@ -1,6 +1,6 @@
-wexample_wex_addon_dev_python-0.1.1.dist-info/METADATA,sha256=hN6jSzby21sI5GgKk1WEPI81RMzAVGI44EAQMqJE1Ng,6259
-wexample_wex_addon_dev_python-0.1.1.dist-info/WHEEL,sha256=Z36eTX6lG3PITRleSd5hAZHCcz52yg3c0JQVxKBbLW0,90
-wexample_wex_addon_dev_python-0.1.1.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
+wexample_wex_addon_dev_python-7.0.0.dist-info/METADATA,sha256=vgKhE5kJFtokoCULRFyeSDrOSPfPkX8vK26Nv8AgMI0,11753
+wexample_wex_addon_dev_python-7.0.0.dist-info/WHEEL,sha256=Z36eTX6lG3PITRleSd5hAZHCcz52yg3c0JQVxKBbLW0,90
+wexample_wex_addon_dev_python-7.0.0.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
 wexample_wex_addon_dev_python/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 wexample_wex_addon_dev_python/__pycache__/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 wexample_wex_addon_dev_python/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -35,13 +35,15 @@ wexample_wex_addon_dev_python/middleware/__pycache__/__init__.py,sha256=47DEQpj8
 wexample_wex_addon_dev_python/middleware/each_python_file_middleware.py,sha256=UzNEpedCYf31aNONFl0SuSJnoXRzhJhgEiTCaPark6E,2311
 wexample_wex_addon_dev_python/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 wexample_wex_addon_dev_python/python_addon_manager.py,sha256=Mmr9F5lOS2gbb8JTB4-vTri4Qn5Cd2Jukjk7uiTr1Hs,582
-wexample_wex_addon_dev_python/resources/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+wexample_wex_addon_dev_python/resources/.wex.yml,sha256=JdIF6nGkFcfi76yZYGlXxeWfOK4eAUSV_gAn6i3hk2w,32
+wexample_wex_addon_dev_python/resources/docker/Dockerfile.python-profiling,sha256=5ujzXfWNN2nv8qQzCLel6dlOwLQ1XhIGZuqplCNB_vQ,290
 wexample_wex_addon_dev_python/resources/package_publish_gitlab.yml,sha256=WVMj-DeFedQak5s5FraEnM1Rx1-ut4KgPodvAVv25ZM,304
-wexample_wex_addon_dev_python/resources/readme_templates/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 wexample_wex_addon_dev_python/resources/readme_templates/tests.md.j2,sha256=tKLcDwx7jhQkryXIxWr12AK-hKEaP6Rusu2MrluiABs,1289
 wexample_wex_addon_dev_python/workdir/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 wexample_wex_addon_dev_python/workdir/__pycache__/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-wexample_wex_addon_dev_python/workdir/python_package_workdir.py,sha256=Fd2A7Qpsy_jstE4zj6AD4PPbMSOGkoBibhCFLDAZrXo,17637
+wexample_wex_addon_dev_python/workdir/mixin/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+wexample_wex_addon_dev_python/workdir/mixin/with_profiling_python_workdir_mixin.py,sha256=rWf_AMq4YM_vvKYZiXyhFeAz2xg0KMt_u-1FJACtvjc,3042
+wexample_wex_addon_dev_python/workdir/python_package_workdir.py,sha256=cc-taJ9D11qkQM0leiAK-rg-5nCWENgueKOSwKXC758,18839
 wexample_wex_addon_dev_python/workdir/python_packages_suite_workdir.py,sha256=ICHHewLpsXiheYzGDEahphBryH98ZVezWzSAy6A5w5I,2874
-wexample_wex_addon_dev_python/workdir/python_workdir.py,sha256=tx6UcaBHnrq9khQ6ndG14BzFPNOlqhl-626iNoL6T1o,18078
-wexample_wex_addon_dev_python-0.1.1.dist-info/RECORD,,
+wexample_wex_addon_dev_python/workdir/python_workdir.py,sha256=V6RB-Qm7HM5k_1qc7yL6a1y4EKjBsvy4V5VkXhcR37c,18244
+wexample_wex_addon_dev_python-7.0.0.dist-info/RECORD,,