example-pkg

Selamy Labs Python repository template. Create a repo from this template, then rename example_pkg everywhere and replace the placeholder logic. It starts at the OSS-excellence bar by construction: LICENSE, the shared reusable CI (lint + tests + coverage), a src/ layout, and tests that already pass.

Use this template

1. Click Use this template → create your repo.
2. Rename the package: src/example_pkg/ → src/<your_pkg>/, and update name, [tool.hatch.build.targets.wheel] packages, and [tool.coverage.run] source in pyproject.toml.
3. Replace core.py + its tests with your real code, keeping coverage ≥ 90%.
4. Fill in this README (what/why/install/usage), set the repo description + topics, and keep CHANGELOG.md current for every release.

Install

pip install -e ".[test]"        # local dev
# or, for an MCP/CLI entry point, expose it under [project.scripts]

Usage

from example_pkg import greet

greet("world")  # "Hello, world!"

Develop

ruff format . && ruff check .
coverage run -m pytest && coverage report --fail-under=90

CI runs the same steps via the shared reusable workflow (selamy-labs/.github → python-ci.yml), so the repo's check is defined once, org-wide.

Standards

This repo meets the public-repo bar: LICENSE, CHANGELOG, reusable CI with a coverage floor, src/ layout, and the org-wide community-health defaults. Keep them.