irminsul 0.1.0__tar.gz

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

@@ -0,0 +1,74 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+      - name: Ruff
+        run: ruff check .
+      - name: Ruff format
+        run: ruff format --check .
+
+  type:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+      - name: Mypy
+        run: mypy
+
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - 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: Pytest
+        run: pytest -q --cov=irminsul --cov-report=term-missing
+
+  dogfood:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[mkdocs]"
+      - name: irminsul check (self)
+        run: irminsul check --scope=hard
+      - name: irminsul render (self)
+        run: irminsul render

irminsul-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,90 @@
+# Release workflow.
+#
+# Triggers only on `v*.*.*` tag pushes. Three jobs run in parallel: PyPI
+# publish via OIDC trusted publisher, ghcr.io image push, and a Homebrew tap
+# bump via repository_dispatch.
+#
+# One-time setup before the first release:
+#   1. PyPI: at https://pypi.org/manage/account/publishing/, add a trusted
+#      publisher for this repo and the `release.yml` workflow.
+#   2. Homebrew: create a separate repo at <github-user>/homebrew-irminsul.
+#      Generate a fine-grained PAT with contents:write on that repo and add
+#      it here as the secret HOMEBREW_TAP_TOKEN.
+#   3. ghcr.io: nothing — `GITHUB_TOKEN` already has the right scopes.
+
+name: release
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+
+permissions:
+  contents: read
+
+jobs:
+  pypi:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+      - name: Install build tools
+        run: pip install --upgrade build
+      - name: Build wheel and sdist
+        run: python -m build
+      - name: Publish via OIDC
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          skip-existing: true
+
+  docker:
+    name: Push image to ghcr.io
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: docker/setup-buildx-action@v3
+      - name: Log in to ghcr.io
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Resolve version
+        id: ver
+        run: echo "version=${GITHUB_REF_NAME#v}" >> "$GITHUB_OUTPUT"
+      - name: Build and push
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          push: true
+          tags: |
+            ghcr.io/${{ github.repository_owner }}/irminsul:${{ steps.ver.outputs.version }}
+            ghcr.io/${{ github.repository_owner }}/irminsul:latest
+
+  homebrew:
+    name: Bump Homebrew tap
+    runs-on: ubuntu-latest
+    needs: pypi
+    steps:
+      - name: Resolve version
+        id: ver
+        run: echo "version=${GITHUB_REF_NAME#v}" >> "$GITHUB_OUTPUT"
+      - name: Dispatch tap update
+        uses: peter-evans/repository-dispatch@v3
+        with:
+          token: ${{ secrets.HOMEBREW_TAP_TOKEN }}
+          repository: ${{ github.repository_owner }}/homebrew-irminsul
+          event-type: irminsul-release
+          client-payload: |
+            {
+              "version": "${{ steps.ver.outputs.version }}",
+              "tag": "${{ github.ref_name }}"
+            }

irminsul-0.1.0/.gitignore

@@ -0,0 +1,68 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Virtual environments
+.venv/
+venv/
+env/
+ENV/
+
+# Testing & coverage
+.pytest_cache/
+.coverage
+.coverage.*
+htmlcov/
+.tox/
+.nox/
+coverage.xml
+*.cover
+
+# Type checking
+.mypy_cache/
+.ruff_cache/
+
+# Editors
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Irminsul
+site/
+.irminsul-cache/
+# mkdocs.yml is auto-generated by `irminsul render`; do not commit.
+/mkdocs.yml
+# _version.py is generated by hatch-vcs at build/install time; do not commit.
+src/irminsul/_version.py
+
+# Build artifacts
+*.whl
+
+.env
+.env.local
+.env.*.local

irminsul-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,35 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.5.7
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: check-yaml
+      - id: check-toml
+      - id: check-added-large-files
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.11.2
+    hooks:
+      - id: mypy
+        additional_dependencies:
+          - pydantic>=2.7
+          - types-requests
+        files: ^src/
+
+  # Dogfood: run irminsul against its own docs once they exist.
+  # Enabled in Week 4 after seed docs are written.
+  # - repo: local
+  #   hooks:
+  #     - id: irminsul-check
+  #       name: irminsul check
+  #       entry: irminsul check --scope=hard
+  #       language: system
+  #       pass_filenames: false

irminsul-0.1.0/Dockerfile

@@ -0,0 +1,33 @@
+# syntax=docker/dockerfile:1.7
+
+FROM python:3.12-slim AS builder
+
+WORKDIR /build
+
+RUN pip install --no-cache-dir --upgrade pip build
+
+COPY pyproject.toml README.md LICENSE ./
+COPY src ./src
+
+RUN python -m build --wheel --outdir /wheels
+
+
+FROM python:3.12-slim AS runtime
+
+LABEL org.opencontainers.image.title="irminsul"
+LABEL org.opencontainers.image.description="A documentation system for complex codebases."
+LABEL org.opencontainers.image.licenses="AGPL-3.0-or-later"
+LABEL org.opencontainers.image.source="https://github.com/huajie-zhong/irminsul"
+
+RUN useradd --create-home --shell /bin/bash irminsul
+WORKDIR /home/irminsul
+
+COPY --from=builder /wheels /wheels
+RUN pip install --no-cache-dir --no-index --find-links=/wheels irminsul \
+ && rm -rf /wheels
+
+USER irminsul
+WORKDIR /workspace
+
+ENTRYPOINT ["irminsul"]
+CMD ["--help"]