small-python 0.0.1__tar.gz

small_python-0.0.1/.github/workflows/publish.yml

@@ -0,0 +1,64 @@
+name: Publish
+
+on:
+  push:
+    tags:
+      - "v[0-9]+.[0-9]+.[0-9]+"
+      - "v[0-9]+.[0-9]+.[0-9]+-*"
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        run: uv python install
+
+      - name: Check tag matches project version
+        run: |
+          tag="${GITHUB_REF_NAME#v}"
+          version="$(uv version --short)"
+          if [ "$tag" != "$version" ]; then
+            echo "Tag $GITHUB_REF_NAME does not match pyproject version $version" >&2
+            exit 1
+          fi
+
+      - name: Build distributions
+        run: uv build
+
+      - name: Check distributions
+        run: uvx twine check --strict dist/*
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    environment: pypi
+    permissions:
+      id-token: write # trusted publishing to PyPI
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2

small_python-0.0.1/.gitignore

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

small_python-0.0.1/.python-version

@@ -0,0 +1 @@
+3.12

small_python-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ju Lin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

small_python-0.0.1/PKG-INFO

@@ -0,0 +1,64 @@
+Metadata-Version: 2.5
+Name: small-python
+Version: 0.0.1
+Summary: A placeholder Python package.
+Project-URL: Repository, https://github.com/soasme/small-python
+Author-email: Ju Lin <soasme@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# small-python
+
+A placeholder Python package. No functionality yet.
+
+Requires Python 3.12 or newer. Manage the project with [uv](https://docs.astral.sh/uv/):
+
+```sh
+uv sync --locked
+uv run python -c "import small_python"
+uv build
+```
+
+## Publishing
+
+The workflow in `.github/workflows/publish.yml` builds and publishes to PyPI when
+a version tag matching `pyproject.toml` is pushed (for example, `v0.0.1`).
+
+Before the first release, configure a [PyPI Trusted Publisher](https://docs.pypi.org/trusted-publishers/creating-a-project-through-oidc/)
+with these values:
+
+- Project: `small-python`
+- Owner: `soasme`
+- Repository: `small-python`
+- Workflow: `publish.yml`
+- Environment: `pypi`
+
+Create the `pypi` environment in the GitHub repository settings as well.
+No PyPI API token is needed.
+
+To publish the initial version after the repository is pushed:
+
+```sh
+git tag v0.0.1
+git push origin v0.0.1
+```
+
+For later releases, preview a version bump:
+
+```sh
+uv run python scripts/bumpversion.py patch
+```
+
+Use `major`, `minor`, or `patch`. The script clones `origin` into a temporary
+directory, bumps the version and lockfile, builds and checks the distributions,
+and displays the changes. Add `-y` to commit, tag, and push the release:
+
+```sh
+uv run python scripts/bumpversion.py patch -y
+git pull --ff-only
+```
+
+Releases use the remote `main` branch; push any intended changes before running
+the script. The working checkout is left untouched.

small_python-0.0.1/README.md

@@ -0,0 +1,53 @@
+# small-python
+
+A placeholder Python package. No functionality yet.
+
+Requires Python 3.12 or newer. Manage the project with [uv](https://docs.astral.sh/uv/):
+
+```sh
+uv sync --locked
+uv run python -c "import small_python"
+uv build
+```
+
+## Publishing
+
+The workflow in `.github/workflows/publish.yml` builds and publishes to PyPI when
+a version tag matching `pyproject.toml` is pushed (for example, `v0.0.1`).
+
+Before the first release, configure a [PyPI Trusted Publisher](https://docs.pypi.org/trusted-publishers/creating-a-project-through-oidc/)
+with these values:
+
+- Project: `small-python`
+- Owner: `soasme`
+- Repository: `small-python`
+- Workflow: `publish.yml`
+- Environment: `pypi`
+
+Create the `pypi` environment in the GitHub repository settings as well.
+No PyPI API token is needed.
+
+To publish the initial version after the repository is pushed:
+
+```sh
+git tag v0.0.1
+git push origin v0.0.1
+```
+
+For later releases, preview a version bump:
+
+```sh
+uv run python scripts/bumpversion.py patch
+```
+
+Use `major`, `minor`, or `patch`. The script clones `origin` into a temporary
+directory, bumps the version and lockfile, builds and checks the distributions,
+and displays the changes. Add `-y` to commit, tag, and push the release:
+
+```sh
+uv run python scripts/bumpversion.py patch -y
+git pull --ff-only
+```
+
+Releases use the remote `main` branch; push any intended changes before running
+the script. The working checkout is left untouched.

small_python-0.0.1/pyproject.toml

@@ -0,0 +1,19 @@
+[project]
+name = "small-python"
+version = "0.0.1"
+description = "A placeholder Python package."
+readme = "README.md"
+authors = [
+    { name = "Ju Lin", email = "soasme@gmail.com" }
+]
+requires-python = ">=3.12"
+license = "MIT"
+license-files = ["LICENSE"]
+dependencies = []
+
+[project.urls]
+Repository = "https://github.com/soasme/small-python"
+
+[build-system]
+requires = ["hatchling>=1.26"]
+build-backend = "hatchling.build"

small_python-0.0.1/scripts/bumpversion.py

@@ -0,0 +1,70 @@
+#!/usr/bin/env python3
+"""Preview a release in a temporary clone; use -y to commit, tag, and push it."""
+
+from __future__ import annotations
+
+import argparse
+import subprocess
+import tempfile
+from pathlib import Path
+
+RELEASE_FILES = ("pyproject.toml", "uv.lock")
+
+
+def run(*args: str, cwd: Path) -> str:
+    return subprocess.run(
+        args, cwd=cwd, check=True, text=True, capture_output=True
+    ).stdout.strip()
+
+
+def run_checked(*args: str, cwd: Path) -> None:
+    subprocess.run(args, cwd=cwd, check=True)
+
+
+def main() -> None:
+    parser = argparse.ArgumentParser(description=__doc__)
+    parser.add_argument("part", choices=("major", "minor", "patch"))
+    parser.add_argument(
+        "-y", "--yes", action="store_true", help="commit, tag, and push the release"
+    )
+    args = parser.parse_args()
+
+    root = Path(run("git", "rev-parse", "--show-toplevel", cwd=Path.cwd()))
+    origin = run("git", "remote", "get-url", "origin", cwd=root)
+    with tempfile.TemporaryDirectory(prefix="small-python-bumpversion-") as directory:
+        clone = Path(directory) / "small-python"
+        run_checked(
+            "git", "clone", "--quiet", "--branch", "main", origin, str(clone), cwd=root
+        )
+        run_checked("uv", "version", "--bump", args.part, "--no-sync", cwd=clone)
+        version = run("uv", "version", "--short", cwd=clone)
+        tag = f"v{version}"
+        if run("git", "tag", "--list", tag, cwd=clone):
+            raise RuntimeError(f"Tag {tag} already exists.")
+
+        run_checked("uv", "build", cwd=clone)
+        distributions = sorted(
+            str(path)
+            for pattern in ("*.whl", "*.tar.gz")
+            for path in (clone / "dist").glob(pattern)
+        )
+        run_checked("uvx", "twine", "check", "--strict", *distributions, cwd=clone)
+        print("Release plan:", flush=True)
+        run_checked("git", "diff", "--", *RELEASE_FILES, cwd=clone)
+        if args.yes:
+            run_checked("git", "add", *RELEASE_FILES, cwd=clone)
+            run_checked("git", "commit", "-m", f"chore(release): {version}", cwd=clone)
+            run_checked("git", "tag", tag, cwd=clone)
+            run_checked(
+                "git",
+                "push",
+                "--atomic",
+                "origin",
+                "HEAD:main",
+                f"refs/tags/{tag}",
+                cwd=clone,
+            )
+
+
+if __name__ == "__main__":
+    main()

small_python-0.0.1/src/small_python/__init__.py

@@ -0,0 +1 @@
+"""Placeholder for the small-python package."""

small_python-0.0.1/uv.lock

@@ -0,0 +1,8 @@
+version = 1
+revision = 3
+requires-python = ">=3.12"
+
+[[package]]
+name = "small-python"
+version = "0.0.1"
+source = { editable = "." }