emcd-projects

Package Version PyPI - Status Tests Status Code Coverage Percentage Project License Python Versions

🛠️ Administration utilities for managing projects built from the emcd/python-project-common Copier template.

Installation 📦

Method: Install Executable Script

Install via the uv tool command:

uv tool install emcd-projects

or, run directly with uvx:

uvx --from emcd-projects emcdproj

Or, install via pipx:

pipx install emcd-projects

Method: Install Python Package

Install via uv pip command:

uv pip install emcd-projects

Or, install via pip:

pip install emcd-projects

Features

🌐 Static Website Maintenance

  • Generates badges/shields based on test coverage.

  • Maintains index of versioned documentation and coverage reports.

  • No need for Codecov, ReadTheDocs, etc…; static site can be hosted anywhere which can deploy from a Git repo branch (GitHub Pages, etc…).

More Flair

GitHub last commit Copier Hatch pre-commit Pyright Ruff PyPI - Implementation PyPI - Wheel

Architecture

The emcdproj package provides maintenance tooling for projects generated from the python-project-common Copier template. It is one component of a larger repository that also contains the template itself, reusable GitHub Actions workflows, and shared documentation.

Package Modules

emcdproj/
├── __/                      # Centralized import hub
│   ├── __init__.py          # Re-exports core utilities
│   ├── imports.py           # External library imports
│   └── nomina.py            # emcd-projects-specific naming constants
├── __init__.py              # Package entry point and version
├── __main__.py              # CLI entry point for `python -m emcdproj`
├── cli.py                   # Command-line interface implementation
├── exceptions.py            # Package exception hierarchy
├── filesystem.py            # File system operations
├── interfaces.py            # Common interface definitions
├── website.py               # Static website generation and maintenance
└── _typedecls/              # Type declaration stubs

Modules generally use the standard __ import pattern for external dependencies, with exceptions for entry points (__main__.py) and subsystems with direct import requirements.

Key Subsystem Contracts

Static Site Publisher (website.py)

Generates and maintains a static documentation site with versioned content, coverage badges, and stable/development aliases. Invoked by the release workflow after documentation and coverage artifacts are available.

Integration with Reusable Workflows

The xrepo--documenter workflow invokes emcdproj website update as part of documentation publication. The xrepo--reporter workflow produces coverage artifacts consumed by the site publisher.

Table of Contents

Indices