nuv 0.1.0__tar.gz

nuv-0.1.0/.github/copilot-instructions.md

@@ -0,0 +1,65 @@
+# Copilot Instructions
+
+## Project overview
+
+`nuv` is a CLI tool that scaffolds opinionated uv-based Python projects. Running `nuv new <name>` creates a fully configured project with argparse, logging, 100% test coverage, ruff linting/formatting, and ty type checking — all green from commit zero.
+
+## Tech stack
+
+- **Language:** Python 3.14+
+- **Package manager:** [uv](https://docs.astral.sh/uv/)
+- **Testing:** pytest with 100% branch coverage enforced (`pytest-cov`)
+- **Linting/formatting:** [ruff](https://docs.astral.sh/ruff/)
+- **Type checking:** [ty](https://github.com/astral-sh/ty)
+
+## Repository layout
+
+```
+src/nuv/
+  _logging.py       # LOG_FORMAT + configure(); single source of logging config
+  cli.py            # argparse entry point; routes subcommands
+  commands/
+    new.py          # logic for `nuv new`: validate, scaffold, uv sync
+  templates/
+    script/         # *.tpl files rendered via str.format()
+tests/
+  test_new.py       # unit tests (100% coverage required)
+```
+
+## Development commands
+
+```bash
+# Install dev dependencies
+uv sync
+
+# Run all tests (with coverage)
+uv run pytest
+
+# Lint
+uv run ruff check src/ tests/
+
+# Format check
+uv run ruff format --check src/ tests/
+
+# Type check
+uv run ty check src/
+```
+
+## Coding conventions
+
+- All source lives under `src/nuv/`; tests live under `tests/`.
+- 100% branch coverage is enforced — every new code path must have a corresponding test.
+- Use `str.format()` (not f-strings or Jinja) for file templates stored in `src/nuv/templates/`; placeholders use `{name}` syntax, and literal `{`/`}` must be written as `{{`/`}}`.
+- Public functions are typed with PEP 604 union syntax (`X | None`) and return types annotated.
+- Errors are surfaced by raising `ValueError`, `RuntimeError`, or `FileNotFoundError` (for missing templates); the CLI entry point catches these, logs them at ERROR level, and returns exit code 1.
+- Logging is configured once via `_logging.configure()` (defined in `src/nuv/_logging.py`). Each module uses `log = logging.getLogger(__name__)`. `cli.main()` calls `configure(args.log_level)` with a `--log-level` flag (default `WARNING`). Scaffolded projects include an identical `_logging.py` module so the pattern carries forward.
+- Do not use `print()` for user-facing output — use `log.info()` for success messages and `log.error()` for errors.
+- Do not introduce new runtime dependencies without updating `pyproject.toml` and `uv.lock`.
+- Follow ruff lint rules: `E`, `F`, `I`, `UP`, `B`, `SIM`.
+
+## Adding a new archetype
+
+1. Create `src/nuv/templates/<archetype>/` with the required `.tpl` files (see `script/` as a reference).
+2. Add any new logic to `src/nuv/commands/`.
+3. Wire the archetype in `cli.py` if needed.
+4. Add tests to maintain 100% coverage.

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

@@ -0,0 +1,71 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: "3.14"
+          enable-cache: true
+
+      - name: Sync dependencies
+        run: uv sync --frozen
+
+      - name: Lint
+        run: |
+          uv run --frozen ruff check src/ tests/
+          uv run --frozen ruff format --check src/ tests/
+
+      - name: Type check
+        run: uv run --frozen ty check src/
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.14"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          enable-cache: true
+
+      - name: Sync dependencies
+        run: uv sync --frozen
+
+      - name: Test
+        run: uv run --frozen pytest
+
+      - name: Integration smoke test
+        if: matrix.python-version == '3.14'
+        run: |
+          uv run --frozen nuv new smoke-test --at /tmp/smoke-test
+          cd /tmp/smoke-test && uv sync --frozen && uv run --frozen pytest
+
+      - name: Build wheel for distribution smoke tests
+        if: matrix.python-version == '3.14'
+        run: uv build
+
+      - name: Tool install smoke test from wheel
+        if: matrix.python-version == '3.14'
+        run: |
+          uv tool install --force-reinstall dist/*.whl
+          nuv --help
+
+      - name: uvx smoke test from wheel
+        if: matrix.python-version == '3.14'
+        run: uvx --from dist/*.whl nuv --help

nuv-0.1.0/.github/workflows/publish-pypi.yml

@@ -0,0 +1,71 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Validate semver version and tag match
+        if: github.ref_type == 'tag'
+        run: |
+          python - <<'PY'
+          import os
+          import re
+          import tomllib
+          from pathlib import Path
+
+          version = tomllib.loads(Path("pyproject.toml").read_text())["project"]["version"]
+          if not re.fullmatch(r"\d+\.\d+\.\d+", version):
+              raise SystemExit(f"pyproject version must be semver X.Y.Z, got: {version}")
+
+          tag = os.environ["GITHUB_REF_NAME"]
+          if not tag.startswith("v"):
+              raise SystemExit(f"release tag must start with 'v', got: {tag}")
+
+          if tag[1:] != version:
+              raise SystemExit(f"tag {tag} does not match project version {version}")
+          PY
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: "3.14"
+
+      - name: Build distributions
+        run: uv build
+
+      - name: Validate distributions
+        run: uvx twine check dist/*
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/*
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      id-token: write
+    environment:
+      name: pypi
+      url: https://pypi.org/p/nuv
+    steps:
+      - name: Download built artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1