mycom-app 0.1.0__tar.gz

mycom_app-0.1.0/.github/CODEOWNERS

@@ -0,0 +1,4 @@
+# Everyone may change the package code; changes to the CI configuration need a
+# release approver. Paired with "Require review from Code Owners" on main.
+
+/.github/workflows/ @mycom-lab/mycom-approvers

mycom_app-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,50 @@
+name: CI
+
+# Read-only checks: this workflow only checks out code and runs the test suite.
+# It publishes and commits nothing, so it needs no write scopes.
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: Test (python ${{ matrix.python }})
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4
+        with:
+          persist-credentials: false
+
+      - name: Setup Python
+        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5
+        with:
+          python-version: ${{ matrix.python }}
+
+      - name: Install
+        run: |
+          set -euo pipefail
+          python -m pip install --quiet --disable-pip-version-check ".[test]"
+
+      - name: Test
+        run: python -m pytest -q
+
+      - name: Build the wheel to prove packaging works
+        run: |
+          set -euo pipefail
+          python -m pip install --quiet --disable-pip-version-check build
+          python -m build --outdir dist

mycom_app-0.1.0/.gitignore

@@ -0,0 +1,7 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+.pytest_cache/
+.venv/

mycom_app-0.1.0/Dockerfile

@@ -0,0 +1,19 @@
+# Base image pinned by digest (linux/amd64), not by tag: the pipeline builds
+# amd64 only, so the digest is the same thing a tag pull would resolve to.
+FROM python:3.12-slim@sha256:2b4f19dae3a777dfc3b76730bda1e82e1f66ab2a2686fa93ca78edbfb4f04ffe
+
+LABEL org.opencontainers.image.title="mycom-app" \
+      org.opencontainers.image.description="Lab package exercised by a build and publish pipeline"
+
+WORKDIR /app
+
+COPY pyproject.toml README.md ./
+COPY src ./src
+
+RUN pip install --no-cache-dir --no-compile .
+
+# Run unprivileged: the image only needs to print a greeting.
+USER 65532:65532
+
+ENTRYPOINT ["mycom-app"]
+CMD ["greet"]

mycom_app-0.1.0/PKG-INFO

@@ -0,0 +1,48 @@
+Metadata-Version: 2.3
+Name: mycom-app
+Version: 0.1.0
+Summary: Lab package used to exercise a build-and-publish pipeline end to end.
+Author: mycom lab
+License: MIT
+Keywords: lab,release-pipeline
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Provides-Extra: test
+Requires-Dist: pytest>=8.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+# mycom-app
+
+Small, self-contained Python package used as the *source* side of a two-repository
+release lab.
+
+- The package itself does one harmless thing: a CLI with `greet` and `version`.
+- It exists so that a separate pipeline repository has something real to build,
+  test, version-stamp, containerise and publish.
+
+## Layout
+
+```
+pyproject.toml          packaging metadata (the pipeline stamps `version`)
+src/mycom_app/          the package
+tests/                  pytest suite
+Dockerfile              image used by the pipeline's container leg
+```
+
+## Local use
+
+```bash
+python -m pip install -e '.[test]'
+pytest
+mycom-app greet --name lab
+mycom-app version
+```
+
+## Notes for the pipeline
+
+- The version lives only in `pyproject.toml`. The pipeline rewrites that field
+  before building; the package reads the installed distribution metadata, so the
+  two can never disagree.
+- Everything here is throwaway test code. Nothing in this repository is intended
+  for real consumption.

mycom_app-0.1.0/README.md

@@ -0,0 +1,34 @@
+# mycom-app
+
+Small, self-contained Python package used as the *source* side of a two-repository
+release lab.
+
+- The package itself does one harmless thing: a CLI with `greet` and `version`.
+- It exists so that a separate pipeline repository has something real to build,
+  test, version-stamp, containerise and publish.
+
+## Layout
+
+```
+pyproject.toml          packaging metadata (the pipeline stamps `version`)
+src/mycom_app/          the package
+tests/                  pytest suite
+Dockerfile              image used by the pipeline's container leg
+```
+
+## Local use
+
+```bash
+python -m pip install -e '.[test]'
+pytest
+mycom-app greet --name lab
+mycom-app version
+```
+
+## Notes for the pipeline
+
+- The version lives only in `pyproject.toml`. The pipeline rewrites that field
+  before building; the package reads the installed distribution metadata, so the
+  two can never disagree.
+- Everything here is throwaway test code. Nothing in this repository is intended
+  for real consumption.

mycom_app-0.1.0/pyproject.toml

@@ -0,0 +1,33 @@
+[build-system]
+# Upper bound on purpose: newer hatchling releases emit Metadata-Version 2.5,
+# which the publish action's bundled tooling rejects ("'2.5' is not a valid
+# metadata version"). 1.26 emits 2.3.
+requires = ["hatchling>=1.25,<1.27"]
+build-backend = "hatchling.build"
+
+[project]
+name = "mycom-app"
+version = "0.1.0"
+description = "Lab package used to exercise a build-and-publish pipeline end to end."
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "MIT" }
+authors = [{ name = "mycom lab" }]
+keywords = ["lab", "release-pipeline"]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "License :: OSI Approved :: MIT License",
+]
+
+[project.scripts]
+mycom-app = "mycom_app.cli:main"
+
+[project.optional-dependencies]
+test = ["pytest>=8.0"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/mycom_app"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-q"

mycom_app-0.1.0/src/mycom_app/__init__.py

@@ -0,0 +1,21 @@
+"""Lab package.
+
+The version is read from installed distribution metadata so that stamping the
+version into ``pyproject.toml`` at build time is the single source of truth.
+"""
+
+from __future__ import annotations
+
+from importlib.metadata import PackageNotFoundError, version
+
+DISTRIBUTION = "mycom-app"
+
+
+def __version__() -> str:
+    try:
+        return version(DISTRIBUTION)
+    except PackageNotFoundError:  # running from a source checkout
+        return "0.0.0+unknown"
+
+
+__all__ = ["DISTRIBUTION", "__version__"]

mycom_app-0.1.0/src/mycom_app/cli.py

@@ -0,0 +1,40 @@
+"""Tiny CLI used to give the pipeline something real to build, test and ship."""
+
+from __future__ import annotations
+
+import argparse
+import json
+import sys
+
+from mycom_app import __version__
+
+
+def build_parser() -> argparse.ArgumentParser:
+    parser = argparse.ArgumentParser(prog="mycom-app", description="Lab CLI")
+    sub = parser.add_subparsers(dest="command", required=True)
+
+    greet = sub.add_parser("greet", help="print a greeting")
+    greet.add_argument("--name", default="world")
+
+    sub.add_parser("version", help="print the installed version")
+
+    return parser
+
+
+def run(argv: list[str] | None = None) -> int:
+    args = build_parser().parse_args(argv)
+    if args.command == "version":
+        print(json.dumps({"name": "mycom-app", "version": __version__()}))
+        return 0
+    if args.command == "greet":
+        print(f"hello, {args.name}")
+        return 0
+    return 2
+
+
+def main() -> None:
+    sys.exit(run())
+
+
+if __name__ == "__main__":
+    main()

mycom_app-0.1.0/tests/test_cli.py

@@ -0,0 +1,30 @@
+from __future__ import annotations
+
+import json
+
+import pytest
+
+from mycom_app import cli
+
+
+def test_greet_uses_default_name(capsys: pytest.CaptureFixture[str]) -> None:
+    assert cli.run(["greet"]) == 0
+    assert capsys.readouterr().out.strip() == "hello, world"
+
+
+def test_greet_uses_given_name(capsys: pytest.CaptureFixture[str]) -> None:
+    assert cli.run(["greet", "--name", "lab"]) == 0
+    assert capsys.readouterr().out.strip() == "hello, lab"
+
+
+def test_version_prints_json(capsys: pytest.CaptureFixture[str]) -> None:
+    assert cli.run(["version"]) == 0
+    payload = json.loads(capsys.readouterr().out)
+    assert payload["name"] == "mycom-app"
+    assert "version" in payload
+
+
+def test_missing_command_exits() -> None:
+    with pytest.raises(SystemExit) as excinfo:
+        cli.run([])
+    assert excinfo.value.code != 0