proteum 0.0.0__tar.gz

proteum-0.0.0/.github/workflows/release.yml

@@ -0,0 +1,108 @@
+name: Release to PyPI
+
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: read
+
+concurrency:
+  group: release-${{ github.ref }}
+  cancel-in-progress: false
+
+jobs:
+  build:
+    name: Build and validate distributions
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - name: Check out the source
+        uses: actions/checkout@v6
+        with:
+          persist-credentials: false
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.11"
+
+      - name: Confirm the tag matches the package version
+        if: startsWith(github.ref, 'refs/tags/v')
+        run: |
+          python - <<'PY'
+          import os
+          import tomllib
+          from pathlib import Path
+
+          project = tomllib.loads(Path("pyproject.toml").read_text())
+          expected_tag = f"v{project['project']['version']}"
+          actual_tag = os.environ["GITHUB_REF_NAME"]
+          if actual_tag != expected_tag:
+              raise SystemExit(
+                  f"Release tag {actual_tag!r} does not match {expected_tag!r}"
+              )
+          PY
+
+      - name: Install build tools
+        run: python -m pip install build twine
+
+      - name: Build distributions
+        run: python -m build
+
+      - name: Validate distribution metadata
+        run: python -m twine check dist/*
+
+      - name: Store distributions
+        uses: actions/upload-artifact@v5
+        with:
+          name: python-package-distributions
+          path: dist/
+          if-no-files-found: error
+          retention-days: 7
+
+  publish-testpypi:
+    name: Publish to TestPyPI
+    needs: build
+    if: github.event_name == 'workflow_dispatch'
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/project/proteum/
+    permissions:
+      id-token: write
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v6
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish distributions
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  publish-pypi:
+    name: Publish to PyPI
+    needs: build
+    if: startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    environment:
+      name: pypi
+      url: https://pypi.org/project/proteum/
+    permissions:
+      id-token: write
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v6
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish distributions
+        uses: pypa/gh-action-pypi-publish@release/v1

proteum-0.0.0/.gitignore

@@ -0,0 +1,12 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+.mypy_cache/
+.ruff_cache/
+
+# Virtual environments
+.venv

proteum-0.0.0/.python-version

@@ -0,0 +1 @@
+3.10

proteum-0.0.0/PKG-INFO

@@ -0,0 +1,36 @@
+Metadata-Version: 2.4
+Name: proteum
+Version: 0.0.0
+Summary: An early-preview Python package with a small installation-check CLI
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# Proteum
+
+Proteum is an early-preview Python package. Version `0.0.0` provides a small
+command-line interface that confirms the package is installed and reports the
+installed version.
+
+## Install
+
+```console
+python -m pip install proteum
+```
+
+## Use
+
+Confirm the installation:
+
+```console
+$ proteum
+Proteum is installed and ready.
+```
+
+Report the version:
+
+```console
+$ proteum --version
+proteum 0.0.0
+```
+
+The public interface will grow in later preview releases.

proteum-0.0.0/README.md

@@ -0,0 +1,29 @@
+# Proteum
+
+Proteum is an early-preview Python package. Version `0.0.0` provides a small
+command-line interface that confirms the package is installed and reports the
+installed version.
+
+## Install
+
+```console
+python -m pip install proteum
+```
+
+## Use
+
+Confirm the installation:
+
+```console
+$ proteum
+Proteum is installed and ready.
+```
+
+Report the version:
+
+```console
+$ proteum --version
+proteum 0.0.0
+```
+
+The public interface will grow in later preview releases.

proteum-0.0.0/pyproject.toml

@@ -0,0 +1,17 @@
+[build-system]
+requires = ["hatchling>=1.26"]
+build-backend = "hatchling.build"
+
+[project]
+name = "proteum"
+version = "0.0.0"
+description = "An early-preview Python package with a small installation-check CLI"
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = []
+
+[project.scripts]
+proteum = "proteum.cli:main"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/proteum"]

proteum-0.0.0/src/proteum/__init__.py

@@ -0,0 +1,3 @@
+"""Public package metadata for Proteum."""
+
+__version__ = "0.0.0"

proteum-0.0.0/src/proteum/__main__.py

@@ -0,0 +1,5 @@
+"""Run the Proteum command-line interface with ``python -m proteum``."""
+
+from proteum.cli import main
+
+raise SystemExit(main())

proteum-0.0.0/src/proteum/cli.py

@@ -0,0 +1,25 @@
+"""Command-line interface for Proteum."""
+
+from argparse import ArgumentParser
+from collections.abc import Sequence
+
+from proteum import __version__
+
+
+def build_parser() -> ArgumentParser:
+    """Build the Proteum command-line argument parser."""
+    parser = ArgumentParser(prog="proteum")
+    parser.add_argument(
+        "--version",
+        action="version",
+        version=f"%(prog)s {__version__}",
+    )
+    return parser
+
+
+def main(argv: Sequence[str] | None = None) -> int:
+    """Confirm that Proteum is installed and ready."""
+    parser = build_parser()
+    parser.parse_args(argv)
+    print("Proteum is installed and ready.")
+    return 0

proteum-0.0.0/tests/test_cli.py

@@ -0,0 +1,31 @@
+"""Behavior tests for the Proteum command-line interface."""
+
+import unittest
+from contextlib import redirect_stdout
+from io import StringIO
+
+from proteum.cli import main
+
+
+class CliTests(unittest.TestCase):
+    def test_main_confirms_installation(self) -> None:
+        output = StringIO()
+
+        with redirect_stdout(output):
+            exit_code = main([])
+
+        self.assertEqual(exit_code, 0)
+        self.assertEqual(output.getvalue(), "Proteum is installed and ready.\n")
+
+    def test_version_reports_package_version(self) -> None:
+        output = StringIO()
+
+        with self.assertRaisesRegex(SystemExit, "0"):
+            with redirect_stdout(output):
+                main(["--version"])
+
+        self.assertEqual(output.getvalue(), "proteum 0.0.0\n")
+
+
+if __name__ == "__main__":
+    unittest.main()