wexample-wex-addon-dev-python 0.0.48__tar.gz → 0.0.53__tar.gz

wexample_wex_addon_dev_python-0.0.53/PKG-INFO

@@ -0,0 +1,192 @@
+Metadata-Version: 2.1
+Name: wexample-wex-addon-dev-python
+Version: 0.0.53
+Summary: Python dev addon 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
+Project-URL: homepage, https://github.com/wexample/python-wex-dev-python
+Requires-Python: >=3.10
+Requires-Dist: attrs>=23.1.0
+Requires-Dist: cattrs>=23.1.0
+Requires-Dist: jinja2
+Requires-Dist: networkx
+Requires-Dist: pylint
+Requires-Dist: pyright
+Requires-Dist: wexample-filestate-python==0.0.48
+Requires-Dist: wexample-wex-addon-app==0.0.49
+Requires-Dist: wexample-wex-core==6.0.55
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Description-Content-Type: text/markdown
+
+# wexample-wex-addon-dev-python
+
+Version: 0.0.53
+
+Python dev addon for wex
+
+## 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
+```
+
+### 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%.
+
+## Code Quality & Typing
+
+All the suite packages follow strict quality standards:
+
+- **Type hints**: Full type coverage with mypy validation
+- **Code formatting**: Enforced with black and isort
+- **Linting**: Comprehensive checks with custom scripts and tools
+- **Testing**: High test coverage requirements
+
+These standards ensure reliability and maintainability across the suite.
+
+## 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.
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for detailed version history and release notes.
+
+Major changes are documented with migration guides when applicable.
+
+## 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.
+
+## Known Limitations & Roadmap
+
+Current limitations and planned features are tracked in the GitHub issues.
+
+See the [project roadmap](https://github.com/wexample/python-wex-dev-python/issues) for upcoming features and improvements.
+
+## Security Policy
+
+### Reporting Vulnerabilities
+
+If you discover a security vulnerability, please email security@wexample.com.
+
+**Do not** open public issues for security vulnerabilities.
+
+We take security seriously and will respond promptly to verified reports.
+
+## Privacy & Telemetry
+
+This package does **not** collect any telemetry or usage data.
+
+Your privacy is respected — no data is transmitted to external services.
+
+## Support Channels
+
+- **GitHub Issues**: Bug reports and feature requests
+- **GitHub Discussions**: Questions and community support
+- **Documentation**: Comprehensive guides and API reference
+- **Email**: contact@wexample.com for general inquiries
+
+Community support is available through GitHub Discussions.
+
+## Contribution Guidelines
+
+We welcome contributions to the Wexample suite! 
+
+### How to Contribute
+
+1. **Fork** the repository
+2. **Create** a feature branch
+3. **Make** your changes
+4. **Test** thoroughly
+5. **Submit** a pull request
+
+## Maintainers & Authors
+
+Maintained by the Wexample team and community contributors.
+
+See [CONTRIBUTORS.md](CONTRIBUTORS.md) for the full list of contributors.
+
+## License
+
+MIT
+
+## Useful Links
+
+- **Homepage**: https://github.com/wexample/python-wex-dev-python
+- **Documentation**: [docs.wexample.com](https://docs.wexample.com)
+- **Issue Tracker**: https://github.com/wexample/python-wex-dev-python/issues
+- **Discussions**: https://github.com/wexample/python-wex-dev-python/discussions
+- **PyPI**: [pypi.org/project/wexample-wex-addon-dev-python](https://pypi.org/project/wexample-wex-addon-dev-python/)
+
+## Integration in the Suite
+
+This package is part of the **Wexample Suite** — a collection of high-quality Python packages designed to work seamlessly together.
+
+### 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 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.
+

wexample_wex_addon_dev_python-0.0.53/README.md

@@ -0,0 +1,167 @@
+# wexample-wex-addon-dev-python
+
+Version: 0.0.53
+
+Python dev addon for wex
+
+## 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
+```
+
+### 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%.
+
+## Code Quality & Typing
+
+All the suite packages follow strict quality standards:
+
+- **Type hints**: Full type coverage with mypy validation
+- **Code formatting**: Enforced with black and isort
+- **Linting**: Comprehensive checks with custom scripts and tools
+- **Testing**: High test coverage requirements
+
+These standards ensure reliability and maintainability across the suite.
+
+## 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.
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for detailed version history and release notes.
+
+Major changes are documented with migration guides when applicable.
+
+## 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.
+
+## Known Limitations & Roadmap
+
+Current limitations and planned features are tracked in the GitHub issues.
+
+See the [project roadmap](https://github.com/wexample/python-wex-dev-python/issues) for upcoming features and improvements.
+
+## Security Policy
+
+### Reporting Vulnerabilities
+
+If you discover a security vulnerability, please email security@wexample.com.
+
+**Do not** open public issues for security vulnerabilities.
+
+We take security seriously and will respond promptly to verified reports.
+
+## Privacy & Telemetry
+
+This package does **not** collect any telemetry or usage data.
+
+Your privacy is respected — no data is transmitted to external services.
+
+## Support Channels
+
+- **GitHub Issues**: Bug reports and feature requests
+- **GitHub Discussions**: Questions and community support
+- **Documentation**: Comprehensive guides and API reference
+- **Email**: contact@wexample.com for general inquiries
+
+Community support is available through GitHub Discussions.
+
+## Contribution Guidelines
+
+We welcome contributions to the Wexample suite! 
+
+### How to Contribute
+
+1. **Fork** the repository
+2. **Create** a feature branch
+3. **Make** your changes
+4. **Test** thoroughly
+5. **Submit** a pull request
+
+## Maintainers & Authors
+
+Maintained by the Wexample team and community contributors.
+
+See [CONTRIBUTORS.md](CONTRIBUTORS.md) for the full list of contributors.
+
+## License
+
+MIT
+
+## Useful Links
+
+- **Homepage**: https://github.com/wexample/python-wex-dev-python
+- **Documentation**: [docs.wexample.com](https://docs.wexample.com)
+- **Issue Tracker**: https://github.com/wexample/python-wex-dev-python/issues
+- **Discussions**: https://github.com/wexample/python-wex-dev-python/discussions
+- **PyPI**: [pypi.org/project/wexample-wex-addon-dev-python](https://pypi.org/project/wexample-wex-addon-dev-python/)
+
+## Integration in the Suite
+
+This package is part of the **Wexample Suite** — a collection of high-quality Python packages designed to work seamlessly together.
+
+### 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 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.
+

{wexample_wex_addon_dev_python-0.0.48 → wexample_wex_addon_dev_python-0.0.53}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "pdm.backend"
 
 [project]
 name = "wexample-wex-addon-dev-python"
-version = "0.0.48"
+version = "0.0.53"
 description = "Python dev addon for wex"
 authors = [
     { name = "weeger", email = "contact@wexample.com" },
@@ -20,11 +20,13 @@ classifiers = [
 dependencies = [
     "attrs>=23.1.0",
     "cattrs>=23.1.0",
+    "jinja2",
+    "networkx",
     "pylint",
     "pyright",
-    "wexample-filestate-python==0.0.44",
-    "wexample-wex-addon-app==0.0.46",
-    "wexample-wex-core==6.0.48",
+    "wexample-filestate-python==0.0.48",
+    "wexample-wex-addon-app==0.0.49",
+    "wexample-wex-core==6.0.55",
 ]
 
 [project.readme]
@@ -40,6 +42,7 @@ homepage = "https://github.com/wexample/python-wex-dev-python"
 [project.optional-dependencies]
 dev = [
     "pytest",
+    "pytest-cov",
 ]
 
 [tool.pdm]
@@ -50,3 +53,11 @@ package-dir = "src"
 packages = [
     { include = "wexample_wex_addon_dev_python", from = "src" },
 ]
+
+[tool.setuptools.packages.find]
+include = [
+    "*",
+]
+exclude = [
+    "wexample_wex_addon_dev_python.testing*",
+]

{wexample_wex_addon_dev_python-0.0.48 → wexample_wex_addon_dev_python-0.0.53}/src/wexample_wex_addon_dev_python/commands/code/check.py

@@ -44,6 +44,7 @@ def python__code__check(
 ) -> bool:
     """Check a Python file using various code quality tools."""
     from wexample_app.response.failure_response import FailureResponse
+
     from wexample_wex_addon_dev_python.commands.code.check.mypy import _code_check_mypy
     from wexample_wex_addon_dev_python.commands.code.check.pylint import (
         _code_check_pylint,

wexample_wex_addon_dev_python-0.0.53/src/wexample_wex_addon_dev_python/config_value/python_package_readme_config_value.py

@@ -0,0 +1,249 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from wexample_filestate.config_value.readme_content_config_value import (
+    ReadmeContentConfigValue,
+)
+from wexample_helpers.classes.field import public_field
+from wexample_helpers.decorator.base_class import base_class
+
+if TYPE_CHECKING:
+    from wexample_wex_addon_dev_python.workdir.python_package_workdir import (
+        PythonPackageWorkdir,
+    )
+
+
+@base_class
+class PythonPackageReadmeContentConfigValue(ReadmeContentConfigValue):
+    workdir: PythonPackageWorkdir = public_field(
+        description="The python package workdir"
+    )
+
+    def get_templates(self) -> list[str] | None:
+        # Prepare context for Jinja2 rendering
+        context = self._get_template_context()
+
+        # Define fixed order of README sections
+        section_names = [
+            "title",
+            "table-of-contents",
+            "status-compatibility",
+            "prerequisites",
+            "installation",
+            "quickstart",
+            "basic-usage",
+            "configuration",
+            "logging",
+            "api-reference",
+            "examples",
+            "tests",
+            "code-quality",
+            "versioning",
+            "changelog",
+            "migration-notes",
+            "roadmap",
+            "troubleshooting",
+            "security",
+            "privacy",
+            "support",
+            "contribution-guidelines",
+            "maintainers",
+            "license",
+            "useful-links",
+            "suite-integration",
+            "compatibility-matrix",
+            "requirements",
+            "dependencies",
+            "links",
+            "suite-signature",
+        ]
+
+        # First pass: collect available sections (excluding title and table-of-contents)
+        available_sections = []
+        for section_name in section_names:
+            if section_name not in ["title", "table-of-contents"]:
+                # Check if section exists
+                if self._section_exists(section_name):
+                    available_sections.append(
+                        {
+                            "name": section_name,
+                            "title": self._section_name_to_title(section_name),
+                            "anchor": section_name.replace("_", "-"),
+                        }
+                    )
+
+        # Add available sections to context for table-of-contents
+        context["available_sections"] = available_sections
+
+        # Render ordered sections (supports both .md and .md.j2)
+        rendered_content = ""
+        for section_name in section_names:
+            section_content = self._render_readme_section(section_name, context)
+            if section_content:
+                rendered_content += f"{section_content}\n\n"
+
+        return [rendered_content]
+
+    def _get_template_context(self) -> dict:
+        # Use TOMLDocument from the workdir
+        doc = self.workdir.get_project_config()
+        project = doc.get("project", {}) if isinstance(doc, dict) else {}
+
+        # Extract information
+        description = project.get("description", "")
+        python_version = project.get("requires-python", "")
+        dependencies = project.get("dependencies", [])
+        urls = (
+            project.get("urls", {}) if isinstance(project.get("urls", {}), dict) else {}
+        )
+        # Accept both lowercase and capitalized homepage key variants
+        homepage = urls.get("homepage") or urls.get("Homepage") or ""
+        license_field = project.get("license", {})
+        if isinstance(license_field, dict):
+            license_info = license_field.get("text", "") or license_field.get(
+                "file", ""
+            )
+        else:
+            license_info = str(license_field) if license_field else ""
+
+        # Format dependencies list
+        deps_list = "\n".join([f"- {dep}" for dep in dependencies])
+
+        return {
+            "package_name": self.workdir.get_package_name(),
+            "version": self.workdir.get_project_version(),
+            "description": description,
+            "python_version": python_version,
+            "dependencies": dependencies,
+            "deps_list": deps_list,
+            "homepage": homepage,
+            "license_info": license_info,
+            "workdir": self.workdir,
+        }
+
+    def _render_readme_section(self, section_name: str, context: dict) -> str | None:
+        """
+        Render a README section from .md or .md.j2 file with Jinja2 support.
+
+        Searches in three levels (in order):
+        1. Package-level templates
+        2. Suite-level templates
+        3. Default templates (bundled with the module)
+
+        Tries .md.j2 first, then .md. Both formats support Jinja2 variables.
+
+        Args:
+            section_name: Name of the section (without extension)
+            context: Jinja2 context variables for rendering
+
+        Returns:
+            Rendered content or None if section file not found
+        """
+        from pathlib import Path
+
+        from jinja2 import Environment, FileSystemLoader, TemplateNotFound
+        from wexample_app.const.globals import WORKDIR_SETUP_DIR
+
+        workdir_path = self.workdir.get_path()
+
+        search_paths = [
+            workdir_path / WORKDIR_SETUP_DIR / "knowledge" / "readme",  # Package-level
+        ]
+
+        # Package may have a suite.
+        suite_path = self.workdir.find_suite_workdir_path()
+        if suite_path is not None:
+            search_paths.append(
+                suite_path
+                / WORKDIR_SETUP_DIR
+                / "knowledge"
+                / "package-readme",  # Suite-level
+            )
+
+        # Add default templates path (bundled with the module)
+        default_templates_path = (
+            Path(__file__).parent.parent / "resources" / "readme_templates"
+        )
+        search_paths.append(default_templates_path)
+
+        # Try .md.j2 first (Jinja2 template)
+        for search_path in search_paths:
+            if not search_path.exists():
+                continue
+
+            env = Environment(loader=FileSystemLoader(str(search_path)))
+            try:
+                template = env.get_template(f"{section_name}.md.j2")
+                return template.render(context)
+            except TemplateNotFound:
+                pass
+
+        # Try .md (static markdown, still rendered with Jinja2)
+        for search_path in search_paths:
+            md_path = search_path / f"{section_name}.md"
+            if md_path.exists():
+                content = md_path.read_text(encoding="utf-8")
+                env = Environment(loader=FileSystemLoader(str(search_path)))
+                template = env.from_string(content)
+                return template.render(context)
+
+        return None
+
+    def _section_exists(self, section_name: str) -> bool:
+        """
+        Check if a section file exists (.md or .md.j2).
+
+        Searches in three levels:
+        1. Package-level templates
+        2. Suite-level templates
+        3. Default templates (bundled with the module)
+
+        Args:
+            section_name: Name of the section (without extension)
+
+        Returns:
+            True if section file exists, False otherwise
+        """
+        from pathlib import Path
+
+        from wexample_app.const.globals import WORKDIR_SETUP_DIR
+
+        workdir_path = self.workdir.get_path()
+
+        search_paths = [
+            workdir_path / WORKDIR_SETUP_DIR / "knowledge" / "readme",
+        ]
+
+        # Package may have a suite.
+        suite_path = self.workdir.find_suite_workdir_path()
+        if suite_path is not None:
+            search_paths.append(
+                suite_path / WORKDIR_SETUP_DIR / "knowledge" / "package-readme",
+            )
+
+        # Add default templates path (bundled with the module)
+        default_templates_path = (
+            Path(__file__).parent.parent / "resources" / "readme_templates"
+        )
+        search_paths.append(default_templates_path)
+
+        for search_path in search_paths:
+            if (search_path / f"{section_name}.md.j2").exists():
+                return True
+            if (search_path / f"{section_name}.md").exists():
+                return True
+
+        return False
+
+    def _section_name_to_title(self, section_name: str) -> str:
+        """
+        Convert section name to human-readable title.
+
+        Args:
+            section_name: Section name (e.g., "basic-usage")
+
+        Returns:
+            Human-readable title (e.g., "Basic Usage")
+        """
+        return section_name.replace("-", " ").replace("_", " ").title()