scaffld 0.1.0__py3-none-any.whl

scaffld/__init__.py

@@ -0,0 +1,7 @@
+"""scaffld -- scaffold new projects in seconds with a friendly TUI."""
+
+from __future__ import annotations
+
+__version__ = "0.1.0"
+
+__all__ = ["__version__"]

scaffld/__main__.py

@@ -0,0 +1,8 @@
+"""Enable ``python -m scaffld``."""
+
+from __future__ import annotations
+
+from .cli import main
+
+if __name__ == "__main__":
+    main()

scaffld/builtins/python-api/files/.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+      - name: Test
+        run: pytest -q

scaffld/builtins/python-api/files/.gitignore

@@ -0,0 +1,25 @@
+# Byte-compiled / optimized
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Test & coverage
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+.mypy_cache/
+.ruff_cache/
+
+# Editors / OS
+.idea/
+.vscode/
+.DS_Store

scaffld/builtins/python-api/files/.pre-commit-config.yaml

@@ -0,0 +1,14 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.9
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-yaml
+      - id: check-toml

scaffld/builtins/python-api/files/LICENSE

@@ -0,0 +1 @@
+{{ license_text }}

scaffld/builtins/python-api/files/README.md

@@ -0,0 +1,29 @@
+# {{ project_name }}
+
+{{ description }}
+
+## Install
+
+```bash
+python -m venv .venv && source .venv/bin/activate
+pip install -e ".[dev]"
+```
+
+## Run
+
+```bash
+uvicorn {{ package_name }}.app:app --reload
+# GET http://127.0.0.1:8000/health   -> {"status": "ok"}
+# GET http://127.0.0.1:8000/greet/you -> {"message": "Hello, you!"}
+```
+
+## Development
+
+```bash
+pytest
+```
+{% if has_license %}
+## License
+
+{{ license }}. See [LICENSE](LICENSE).
+{% endif %}

scaffld/builtins/python-api/files/pyproject.toml

@@ -0,0 +1,30 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "{{ project_slug }}"
+version = "0.1.0"
+description = "{{ description }}"
+readme = "README.md"
+requires-python = ">={{ python_version }}"
+{% if has_license %}license = "{{ license }}"
+license-files = ["LICENSE"]
+{% endif %}authors = [{ name = "{{ author }}"{% if has_email %}, email = "{{ author_email }}"{% endif %} }]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Framework :: FastAPI",
+]
+dependencies = [
+    "fastapi>=0.110",
+    "uvicorn[standard]>=0.29",
+]
+
+[project.optional-dependencies]
+dev = ["pytest>=8.0", "httpx>=0.27"]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

scaffld/builtins/python-api/files/src/{{ package_name }}/__init__.py

@@ -0,0 +1,7 @@
+"""{{ description }}"""
+
+from __future__ import annotations
+
+__version__ = "0.1.0"
+
+__all__ = ["__version__"]

scaffld/builtins/python-api/files/src/{{ package_name }}/app.py

@@ -0,0 +1,21 @@
+"""FastAPI application for {{ project_name }}."""
+
+from __future__ import annotations
+
+from fastapi import FastAPI
+
+from . import __version__
+
+app = FastAPI(title="{{ project_name }}", version=__version__)
+
+
+@app.get("/health")
+def health() -> dict[str, str]:
+    """Liveness probe."""
+    return {"status": "ok"}
+
+
+@app.get("/greet/{name}")
+def greet(name: str) -> dict[str, str]:
+    """Greet ``name``."""
+    return {"message": f"Hello, {name}!"}

scaffld/builtins/python-api/files/tests/test_app.py

@@ -0,0 +1,17 @@
+from fastapi.testclient import TestClient
+
+from {{ package_name }}.app import app
+
+client = TestClient(app)
+
+
+def test_health() -> None:
+    response = client.get("/health")
+    assert response.status_code == 200
+    assert response.json() == {"status": "ok"}
+
+
+def test_greet() -> None:
+    response = client.get("/greet/{{ project_name }}")
+    assert response.status_code == 200
+    assert response.json() == {"message": "Hello, {{ project_name }}!"}

scaffld/builtins/python-api/template.toml

@@ -0,0 +1,4 @@
+[template]
+name = "python-api"
+kind = "api"
+description = "FastAPI service with a health route, typed handlers, and CI."

scaffld/builtins/python-cli/files/.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+      - name: Test
+        run: pytest -q

scaffld/builtins/python-cli/files/.gitignore

@@ -0,0 +1,25 @@
+# Byte-compiled / optimized
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Test & coverage
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+.mypy_cache/
+.ruff_cache/
+
+# Editors / OS
+.idea/
+.vscode/
+.DS_Store

scaffld/builtins/python-cli/files/.pre-commit-config.yaml

@@ -0,0 +1,14 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.9
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-yaml
+      - id: check-toml

scaffld/builtins/python-cli/files/LICENSE

@@ -0,0 +1 @@
+{{ license_text }}

scaffld/builtins/python-cli/files/README.md

@@ -0,0 +1,30 @@
+# {{ project_name }}
+
+{{ description }}
+
+## Install
+
+```bash
+python -m venv .venv && source .venv/bin/activate
+pip install -e ".[dev]"
+```
+
+## Usage
+
+```bash
+{{ project_slug }} World
+# -> Hello, World!
+
+{{ project_slug }} --version
+```
+
+## Development
+
+```bash
+pytest
+```
+{% if has_license %}
+## License
+
+{{ license }}. See [LICENSE](LICENSE).
+{% endif %}

scaffld/builtins/python-cli/files/pyproject.toml

@@ -0,0 +1,29 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "{{ project_slug }}"
+version = "0.1.0"
+description = "{{ description }}"
+readme = "README.md"
+requires-python = ">={{ python_version }}"
+{% if has_license %}license = "{{ license }}"
+license-files = ["LICENSE"]
+{% endif %}authors = [{ name = "{{ author }}"{% if has_email %}, email = "{{ author_email }}"{% endif %} }]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Environment :: Console",
+]
+
+[project.optional-dependencies]
+dev = ["pytest>=8.0"]
+
+[project.scripts]
+{{ project_slug }} = "{{ package_name }}.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

scaffld/builtins/python-cli/files/src/{{ package_name }}/__init__.py

@@ -0,0 +1,7 @@
+"""{{ description }}"""
+
+from __future__ import annotations
+
+__version__ = "0.1.0"
+
+__all__ = ["__version__"]

scaffld/builtins/python-cli/files/src/{{ package_name }}/cli.py

@@ -0,0 +1,29 @@
+"""Command-line interface for {{ project_name }}."""
+
+from __future__ import annotations
+
+import argparse
+from typing import Optional, Sequence
+
+from . import __version__
+
+
+def build_parser() -> argparse.ArgumentParser:
+    parser = argparse.ArgumentParser(
+        prog="{{ project_slug }}",
+        description="{{ description }}",
+    )
+    parser.add_argument("--version", action="version", version=f"%(prog)s {__version__}")
+    parser.add_argument("name", nargs="?", default="world", help="who to greet")
+    return parser
+
+
+def main(argv: Optional[Sequence[str]] = None) -> int:
+    """Entry point. Returns a process exit code."""
+    args = build_parser().parse_args(argv)
+    print(f"Hello, {args.name}!")
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

scaffld/builtins/python-cli/files/tests/test_cli.py

@@ -0,0 +1,15 @@
+from {{ package_name }}.cli import build_parser, main
+
+
+def test_default_greeting(capsys) -> None:
+    assert main([]) == 0
+    assert capsys.readouterr().out.strip() == "Hello, world!"
+
+
+def test_named_greeting(capsys) -> None:
+    assert main(["scaffld"]) == 0
+    assert capsys.readouterr().out.strip() == "Hello, scaffld!"
+
+
+def test_parser_builds() -> None:
+    assert build_parser().prog == "{{ project_slug }}"

scaffld/builtins/python-cli/template.toml

@@ -0,0 +1,4 @@
+[template]
+name = "python-cli"
+kind = "cli"
+description = "Zero-dependency argparse CLI with a console-script entry point."

scaffld/builtins/python-lib/files/.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+      - name: Test
+        run: pytest -q

scaffld/builtins/python-lib/files/.gitignore

@@ -0,0 +1,25 @@
+# Byte-compiled / optimized
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Test & coverage
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+.mypy_cache/
+.ruff_cache/
+
+# Editors / OS
+.idea/
+.vscode/
+.DS_Store

scaffld/builtins/python-lib/files/.pre-commit-config.yaml

@@ -0,0 +1,14 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.9
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-yaml
+      - id: check-toml

scaffld/builtins/python-lib/files/LICENSE

@@ -0,0 +1 @@
+{{ license_text }}

scaffld/builtins/python-lib/files/README.md

@@ -0,0 +1,31 @@
+# {{ project_name }}
+
+{{ description }}
+
+## Install
+
+```bash
+python -m venv .venv && source .venv/bin/activate
+pip install -e ".[dev]"
+```
+
+## Usage
+
+```python
+from {{ package_name }} import greet
+
+print(greet("{{ project_name }}"))
+# -> Hello, {{ project_name }}!
+```
+
+## Development
+
+```bash
+pytest            # run the test suite
+pre-commit install  # optional: format & lint on commit
+```
+{% if has_license %}
+## License
+
+{{ license }}. See [LICENSE](LICENSE).
+{% endif %}

scaffld/builtins/python-lib/files/pyproject.toml

@@ -0,0 +1,27 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "{{ project_slug }}"
+version = "0.1.0"
+description = "{{ description }}"
+readme = "README.md"
+requires-python = ">={{ python_version }}"
+{% if has_license %}license = "{{ license }}"
+license-files = ["LICENSE"]
+{% endif %}authors = [{ name = "{{ author }}"{% if has_email %}, email = "{{ author_email }}"{% endif %} }]
+keywords = []
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Typing :: Typed",
+]
+
+[project.optional-dependencies]
+dev = ["pytest>=8.0"]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

scaffld/builtins/python-lib/files/src/{{ package_name }}/__init__.py

@@ -0,0 +1,16 @@
+"""{{ description }}"""
+
+from __future__ import annotations
+
+__version__ = "0.1.0"
+
+__all__ = ["__version__", "greet"]
+
+
+def greet(name: str = "world") -> str:
+    """Return a friendly greeting.
+
+    >>> greet("{{ project_name }}")
+    'Hello, {{ project_name }}!'
+    """
+    return f"Hello, {name}!"

scaffld/builtins/python-lib/files/tests/test_{{ package_name }}.py

@@ -0,0 +1,9 @@
+from {{ package_name }} import greet
+
+
+def test_greet_default() -> None:
+    assert greet() == "Hello, world!"
+
+
+def test_greet_name() -> None:
+    assert greet("{{ project_name }}") == "Hello, {{ project_name }}!"

scaffld/builtins/python-lib/template.toml

@@ -0,0 +1,4 @@
+[template]
+name = "python-lib"
+kind = "library"
+description = "Importable Python library: src/ layout, typed API, tests, and CI."