afterpython 0.1.0__py3-none-any.whl → 0.1.0.dev6__py3-none-any.whl

afterpython/{templates/pre-commit-config-template.yaml → .pre-commit-config.yaml}

@@ -23,7 +23,7 @@ repos:
     stages:
     - pre-commit
 - repo: https://github.com/astral-sh/ruff-pre-commit
-  rev: v0.14.8
+  rev: v0.14.5
   hooks:
   - id: ruff-check
     stages:

afterpython/_io/toml.py

@@ -1,11 +1,9 @@
 from __future__ import annotations
-
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
-    from pathlib import Path
-
     from tomlkit.toml_document import TOMLDocument
+    from pathlib import Path
 
 import tomlkit
 
@@ -18,7 +16,7 @@ def _from_tomlkit(value):
     - tomlkit containers → plain Python containers
     - tomlkit primitives → plain Python primitives
     """
-    from tomlkit.items import AoT, Array, InlineTable, Table
+    from tomlkit.items import Array, InlineTable, Table, AoT
 
     if value is None:
         return None
@@ -60,7 +58,7 @@ def _to_tomlkit(value):
     - List of dicts → array of inline tables: [{key = val}]
     - Nested dicts → nested tables with proper structure
     """
-    from tomlkit import array, inline_table
+    from tomlkit import inline_table, array
 
     if value is None:
         return None

afterpython/_paths.py

@@ -1,5 +1,5 @@
-from dataclasses import dataclass, field
 from pathlib import Path
+from dataclasses import dataclass, field
 
 
 @dataclass

afterpython/_typing.py

@@ -1,4 +1,5 @@
-from typing import Literal, TypeAlias
+from typing import TypeAlias, Literal
+
 
 NodeEnv: TypeAlias = dict[str, str]
 tContentType = Literal["doc", "blog", "tutorial", "example", "guide"]

afterpython/builders/__init__.py

@@ -1,17 +1,8 @@
-from afterpython.builders.content_json import build_content_json
-from afterpython.builders.index_md import (
-    create_placeholder_index_md_files,
-    delete_placeholder_index_md_files,
-)
-from afterpython.builders.jupyter_notebook import build_jupyter_notebooks
-from afterpython.builders.markdown import build_markdown
 from afterpython.builders.metadata import build_metadata
+from afterpython.builders.molab import add_molab_badge_to_jupyter_notebooks
+
 
 __all__ = (
-    "build_content_json",
-    "build_jupyter_notebooks",
-    "build_markdown",
+    "add_molab_badge_to_jupyter_notebooks",
     "build_metadata",
-    "create_placeholder_index_md_files",
-    "delete_placeholder_index_md_files",
 )

afterpython/builders/metadata.py

@@ -1,5 +1,4 @@
 from __future__ import annotations
-
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
@@ -7,10 +6,9 @@ if TYPE_CHECKING:
 
 import json
 
-import click
-
 import afterpython as ap
 
+
 build_path = ap.paths.build_path
 
 
@@ -25,22 +23,20 @@ def convert_paths():
         markdown_text = metadata["description"]
 
     # Replace with the correct paths
-    updated_markdown = markdown_text.replace("afterpython/static/", "/")
+    updated_markdown = markdown_text.replace("./afterpython/static/", "/")
 
     # Write back to metadata.json
     metadata["description"] = updated_markdown
     with open(build_path / "metadata.json", "w") as f:
         json.dump(metadata, f, indent=2)
 
-    click.echo("Completed path conversion in metadata.json")
+    print("Completed path conversion in metadata.json")
 
 
 def build_metadata():
     """Build metadata.json using pyproject.toml"""
     from afterpython.tools.pyproject import read_metadata
 
-    click.echo("Building metadata.json...")
-
     metadata: StandardMetadata = read_metadata()
 
     # Write to metadata.json

afterpython/builders/molab.py

@@ -0,0 +1,99 @@
+from __future__ import annotations
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from afterpython._typing import tContentType
+
+import json
+from pathlib import Path
+
+from pyproject_metadata import StandardMetadata
+
+import afterpython as ap
+from afterpython.tools.pyproject import read_metadata
+from afterpython.const import CONTENT_TYPES
+
+
+def _get_molab_badge() -> str:
+    return "https://marimo.io/molab-shield.svg"
+
+
+def _create_molab_url(github_url: str, content_path: Path):
+    """Create a molab URL for a given content type and notebook path.
+    Args:
+        github_url: str, e.g. "https://github.com/AfterPythonOrg/afterpython"
+        content_path: str, e.g. "tutorial/test.ipynb"
+    """
+    github_url = github_url.replace("https://github.com/", "github/")
+    return f"https://molab.marimo.io/{github_url}/blob/main/afterpython/{content_path.as_posix()}"
+
+
+def add_molab_badge_to_jupyter_notebooks(content_type: tContentType):
+    """Add a badge markdown cell to the top of Jupyter notebooks in the given content type directory, e.g. tutorial/, blog/, etc.
+    # NOTE
+    Note that the jupyter notebooks need to exist in the github repository first.
+    If you have renamed a notebook, you need to push the changes to the github repository first for the badge to work.
+    """
+    assert content_type.lower() in CONTENT_TYPES, (
+        f"Invalid content type: {content_type}"
+    )
+    metadata: StandardMetadata = read_metadata()
+
+    if "repository" not in metadata.urls:
+        return "Repository URL not found in [project.urls] in pyproject.toml, cannot add molab badge"
+    else:
+        github_url = metadata.urls["repository"]
+
+    path = ap.paths.afterpython_path / content_type.lower()
+
+    # iterate over all files in the path
+    for notebook_path in path.rglob("*.ipynb"):
+        # Skip files in _build directory
+        if "_build" in notebook_path.parts:
+            continue
+
+        # Get path relative to afterpython/ (includes tutorial/ in the path)
+        content_path = notebook_path.relative_to(ap.paths.afterpython_path)
+        molab_url = _create_molab_url(github_url, content_path)
+        badge_md = f"[![Open in molab]({_get_molab_badge()})]({molab_url})"
+
+        # Read the notebook
+        try:
+            # Read the notebook
+            with open(notebook_path) as f:
+                notebook = json.load(f)
+        except json.JSONDecodeError:
+            print(f"✗ Skipping {content_path} - invalid or empty JSON")
+            continue
+        except Exception as e:
+            print(f"✗ Error reading {content_path}: {e}")
+            continue
+
+        # Validate notebook structure
+        if "cells" not in notebook:
+            print(f"✗ Skipping {content_path} - not a valid Jupyter notebook")
+            continue
+
+        # Create a markdown cell with the badge
+        badge_cell = {
+            "cell_type": "markdown",
+            "id": "molab-badge-cell",  # Unique ID for the badge cell
+            "metadata": {
+                "tags": ["molab", "hide-input"]  # Optional: use MyST tags
+            },
+            "source": [badge_md],
+        }
+
+        # Check if first cell is already a badge cell (avoid duplicates)
+        if notebook["cells"] and notebook["cells"][0].get("id") == "molab-badge-cell":
+            # Update existing badge
+            notebook["cells"][0] = badge_cell
+            print(f"✓ Updated molab badge in: {content_path}")
+        else:
+            # Insert at the beginning
+            notebook["cells"].insert(0, badge_cell)
+            print(f"✓ Added molab badge to: {content_path}")
+
+        # Write back
+        with open(notebook_path, "w") as f:
+            json.dump(notebook, f, indent=1)

afterpython/cli/__init__.py

@@ -1,3 +1,4 @@
 from afterpython.cli.main import afterpython_group
 
+
 __all__ = ["afterpython_group"]

afterpython/cli/commands/build.py

@@ -1,13 +1,12 @@
 from __future__ import annotations
-
-from collections.abc import Callable
 from typing import TYPE_CHECKING
+from collections.abc import Callable
 
 if TYPE_CHECKING:
-    from pathlib import Path
-
     from afterpython._typing import NodeEnv
+    from pathlib import Path
 
+import os
 import shutil
 import subprocess
 
@@ -15,15 +14,12 @@ import click
 from click.exceptions import Exit
 
 import afterpython as ap
+from afterpython.utils import find_node_env
+from afterpython.const import CONTENT_TYPES
 from afterpython.builders import (
-    build_content_json,
-    build_jupyter_notebooks,
-    build_markdown,
     build_metadata,
-    create_placeholder_index_md_files,
-    delete_placeholder_index_md_files,
+    add_molab_badge_to_jupyter_notebooks,
 )
-from afterpython.const import CONTENT_TYPES
 
 
 def determine_base_path() -> str:
@@ -33,13 +29,13 @@ def determine_base_path() -> str:
         Empty string if custom domain is configured (no github.io in URL)
         /repo-name if using default GitHub Pages URL (contains github.io)
     """
-    from afterpython._io.toml import _from_tomlkit
     from afterpython.tools._afterpython import read_afterpython
     from afterpython.tools.pyproject import read_metadata
+    from afterpython._io.toml import _from_tomlkit
 
     # Read website URL from afterpython.toml
     afterpython = read_afterpython()
-    website_url = str(_from_tomlkit(afterpython.get("website", {})).get("url", ""))
+    website_url = str(_from_tomlkit(afterpython["website"]).get("url", ""))
 
     # If custom domain (no github.io), no BASE_PATH needed
     if "github.io" not in website_url:
@@ -71,31 +67,22 @@ def prebuild():
                 "Run 'ap init' first to set up your project."
             )
 
-    def _clean_up_builds():
-        click.echo("Cleaning up builds...")
+    def _clean_build_directory():
+        print("Cleaning up build directory...")
         build_path = ap.paths.build_path
-        website_build_path = ap.paths.website_path / "build"
-        # clean up content builds in _website/static/{content_type}
-        website_static_path = ap.paths.website_path / "static"
-        content_build_paths = [
-            website_static_path / content_type for content_type in CONTENT_TYPES
-        ]
-        for path in [build_path, website_build_path, *content_build_paths]:
-            if path.exists():
-                shutil.rmtree(path)
+        if build_path.exists():
+            shutil.rmtree(build_path)
         build_path.mkdir(parents=True, exist_ok=True)
 
     _check_initialized()
-    _clean_up_builds()
+    _clean_build_directory()
 
-    delete_placeholder_index_md_files()
-    create_placeholder_index_md_files()
-    build_metadata()
-    build_markdown()
-    build_jupyter_notebooks()
+    if os.getenv("AP_MOLAB_BADGE", "0") == "1":
+        for content_type in CONTENT_TYPES:
+            add_molab_badge_to_jupyter_notebooks(content_type)
 
 
-def postbuild(dev_build: bool = False):
+def postbuild():
     def _move_files(
         source: Path,
         destination: Path,
@@ -123,9 +110,6 @@ def postbuild(dev_build: bool = False):
             shutil.move(str(source), str(destination))
             print(f"Moved: {source} to {destination}")
 
-    build_content_json()
-    delete_placeholder_index_md_files()
-
     website_static = ap.paths.website_path / "static"
     website_static.mkdir(parents=True, exist_ok=True)
 
@@ -133,24 +117,15 @@ def postbuild(dev_build: bool = False):
         myst_build = ap.paths.afterpython_path / content_type / "_build"
         afterpython_content_build = ap.paths.build_path / content_type
         # Move myst builds from afterpython/{content_type}/_build to afterpython/_build/{content_type}
-        _move_files(myst_build, afterpython_content_build, is_copy=True)
-        # for production build, copy afterpython/_build/{content_type}/html to afterpython/_website/static/{content_type}
-        if not dev_build:
-            _move_files(
-                afterpython_content_build / "html",
-                website_static / content_type,
-                is_copy=True,
-            )
-        # for dev build, copy the files (mainly images, e.g. thumbnails) in site/public/ to afterpython/_website/static/{content_type}/build
-        else:
-            _move_files(
-                afterpython_content_build / "site" / "public",
-                # add build/ to mimic the structure of the production build
-                website_static / content_type / "build",
-                is_copy=True,
-            )
+        _move_files(myst_build, afterpython_content_build, is_copy=False)
+        # Copy afterpython/_build/{content_type}/html to afterpython/_website/static/{content_type}
+        _move_files(
+            afterpython_content_build / "html",
+            website_static / content_type,
+            is_copy=True,
+        )
 
-    # Copy all files (e.g. metadata.json, blog.json etc.) from afterpython/_build to afterpython/_website/static/
+    # Copy all files from afterpython/_build to afterpython/_website/static/
     _move_files(
         ap.paths.build_path,
         website_static,
@@ -173,10 +148,16 @@ def postbuild(dev_build: bool = False):
     ),
 )
 @click.pass_context
+@click.option(
+    "--dev",
+    is_flag=True,
+    hidden=True,  # Internal flag used by `ap dev`, not exposed to users
+    help="Development build - only build metadata for the landing page, skip content and production builds",
+)
 @click.option(
     "--execute", is_flag=True, help="Execute Jupyter notebooks for all content types"
 )
-def build(ctx: click.Context, execute: bool):
+def build(ctx, dev: bool, execute: bool):
     """Build the project website and all contents for production.
 
     This command builds MyST content (doc/blog/tutorial/example/guide) and the SvelteKit website.
@@ -186,11 +167,8 @@ def build(ctx: click.Context, execute: bool):
 
     Use --execute to execute Jupyter notebooks for all content types.
     """
-    from afterpython.utils import (
-        find_node_env,
-        handle_passthrough_help,
-        has_content_for_myst,
-    )
+    from afterpython.utils import has_content_for_myst
+    from afterpython.utils import handle_passthrough_help
 
     # Show both our options and myst's help and exit
     handle_passthrough_help(
@@ -208,53 +186,46 @@ def build(ctx: click.Context, execute: bool):
         click.echo(f"Using BASE_PATH: {base_path}")
     else:
         click.echo("Using BASE_PATH: (empty - custom domain)")
-    node_env: NodeEnv = find_node_env()
-
-    # myst's production build
-    for content_type in CONTENT_TYPES:
-        content_path = ap.paths.afterpython_path / content_type
-        myst_yml_path = content_path / "myst.yml"
 
-        if not content_path.exists():
-            click.echo(f"{content_path} does not exist, skip building {content_type}/")
-            continue
+    click.echo("Building metadata.json...")
+    build_metadata()
 
-        if not myst_yml_path.exists():
-            click.echo(
-                f"No myst.yml found in {content_path}, skip building {content_type}/"
+    # myst's production build
+    if not dev:
+        node_env: NodeEnv = find_node_env()
+        for content_type in CONTENT_TYPES:
+            content_path = paths.afterpython_path / content_type
+            if not has_content_for_myst(content_path):
+                click.echo(f"Skipping {content_type}/ (no content files found)")
+                continue
+
+            click.echo(f"Building {content_type}/...")
+            # NOTE: needs to set BASE_URL so that the project website can link to the content pages correctly at e.g. localhost:5173/doc
+            base_url = f"{base_path}/{content_type}"
+            build_env = {**node_env, "BASE_URL": base_url, "BASE_PATH": base_path}
+            result = subprocess.run(
+                [
+                    "myst",
+                    "build",
+                    "--html",
+                    *(["--execute"] if execute else []),
+                    *ctx.args,
+                ],
+                cwd=content_path,
+                env=build_env,
+                check=False,
             )
-            continue
+            if result.returncode != 0:
+                raise Exit(result.returncode)
 
-        if not has_content_for_myst(content_path):
-            click.echo(f"Skipping {content_type}/ (no content files found)")
-            continue
+    postbuild()
 
-        click.echo(f"Building {content_type}/...")
-        # NOTE: needs to set BASE_URL (used by MyST) so that the project website can link to the content pages correctly at e.g. localhost:5173/doc
-        base_url = f"{base_path}/{content_type}"
-        build_env = {**node_env, "BASE_URL": base_url, "BASE_PATH": base_path}
+    # website's production build
+    if not dev:
+        click.echo("Building project website...")
+        website_env = {**node_env, "BASE_PATH": base_path}
         result = subprocess.run(
-            [
-                "myst",
-                "build",
-                "--html",
-                *(["--execute"] if execute else []),
-                *ctx.args,
-            ],
-            cwd=content_path,
-            env=build_env,
-            check=False,
+            ["pnpm", "build"], cwd=paths.website_path, env=website_env, check=False
         )
-
         if result.returncode != 0:
             raise Exit(result.returncode)
-
-    postbuild(dev_build=False)
-
-    click.echo("Building project website...")
-    website_env = {**node_env, "BASE_PATH": base_path}
-    result = subprocess.run(
-        ["pnpm", "build"], cwd=paths.website_path, env=website_env, check=False
-    )
-    if result.returncode != 0:
-        raise Exit(result.returncode)

afterpython/cli/commands/bump.py

@@ -1,9 +1,6 @@
 import subprocess
 
 import click
-from click.exceptions import Exit
-
-from afterpython.utils import has_pixi
 
 
 @click.command(
@@ -89,30 +86,3 @@ def bump(ctx, release: bool, pre: bool):
                 args = ["--prerelease", prerelease_type, *ctx.args]
 
         subprocess.run(["ap", "cz", "bump", *args])
-
-    # Update pixi.lock after version bump (editable install requires lock refresh)
-    if has_pixi():
-        result = subprocess.run(["pixi", "install"], check=False)
-        if result.returncode != 0:
-            raise Exit(result.returncode)
-
-        # Check if pixi.lock was modified
-        status = subprocess.run(
-            ["git", "diff", "--name-only", "pixi.lock"],
-            capture_output=True,
-            text=True,
-            check=False,
-        )
-        if status.stdout.strip():
-            # Stage and commit pixi.lock
-            subprocess.run(["git", "add", "pixi.lock"], check=True)
-            subprocess.run(
-                [
-                    "git",
-                    "commit",
-                    "-m",
-                    "build: update pixi.lock after version bump",
-                ],
-                check=True,
-            )
-            click.echo("✓ Committed pixi.lock update")

afterpython/cli/commands/check.py

@@ -13,7 +13,7 @@ from click.exceptions import Exit
 )
 @click.pass_context
 def check(ctx):
-    """Run ruff linter (uses afterpython/ruff.toml if available)"""
+    """Simple wrapper for ruff check for convenience, always use the afterpython/ruff.toml if it exists"""
     from afterpython.utils import handle_passthrough_help
 
     # Show both our options and ruff's help and exit

afterpython/cli/commands/clean.py

@@ -1,5 +1,4 @@
 from __future__ import annotations
-
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
@@ -11,8 +10,8 @@ import subprocess
 import click
 from click.exceptions import Exit
 
-from afterpython.const import CONTENT_TYPES
 from afterpython.utils import find_node_env, has_content_for_myst
+from afterpython.const import CONTENT_TYPES
 
 
 @click.command(
@@ -26,10 +25,10 @@ from afterpython.utils import find_node_env, has_content_for_myst
 @click.option(
     "--all",
     is_flag=True,
-    help="Also clean AfterPython build directories (_build/ and _website/build/)",
+    help='--all passed to "myst clean", also clean afterpython build directories (_build/ and _website/build/)',
 )
 def clean(ctx, all: bool):
-    """Clean build artifacts from content types and website"""
+    """Clean the build directory"""
     from afterpython.utils import handle_passthrough_help
 
     # Show both our options and myst's help and exit

afterpython/cli/commands/commit.py

@@ -13,19 +13,10 @@ import click
 )
 @click.pass_context
 @click.option(
-    "--no-cz",
-    "--no-commitizen",
-    is_flag=True,
-    help="Skip 'commitizen' and 'commitizen-branch' pre-commit hooks",
+    "--no-cz", "--no-commitizen", is_flag=True, help="Skip running 'cz commit'"
 )
-@click.option(
-    "--no-pc",
-    "--no-pre-commit",
-    is_flag=True,
-    help="Skip running pre-commit checks before commit",
-)
-def commit(ctx, no_cz: bool, no_pc: bool):
-    """Create a conventional commit with interactive prompts"""
+def commit(ctx, no_cz: bool):
+    """Run 'cz commit'"""
     from afterpython.utils import handle_passthrough_help
 
     # Show both our options and commitizen's help and exit
@@ -35,15 +26,6 @@ def commit(ctx, no_cz: bool, no_pc: bool):
         show_underlying=True,
     )
 
-    # Run pre-commit checks first (unless --no-pc is set)
-    if not no_pc:
-        result = subprocess.run(["ap", "pc", "run"])
-        if result.returncode != 0:
-            click.echo(
-                "❌ Pre-commit checks failed. Please fix the issues and try again."
-            )
-            ctx.exit(1)
-
     if not no_cz:
         subprocess.run(["ap", "cz", "commit", *ctx.args])
     else:

afterpython/cli/commands/commitizen.py

@@ -13,7 +13,7 @@ from click.exceptions import Exit
 )
 @click.pass_context
 def commitizen(ctx):
-    """Run commitizen CLI (uses afterpython/cz.toml)"""
+    """Run commitizen"""
     from afterpython.utils import handle_passthrough_help
 
     # Show both our options and commitizen's help and exit

afterpython/cli/commands/dev.py

@@ -1,19 +1,17 @@
 from __future__ import annotations
-
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
     from afterpython._typing import NodeEnv
 
-import subprocess
 import time
+import subprocess
 
 import click
 from click.exceptions import Exit
 
-from afterpython.cli.commands.build import postbuild, prebuild
+from afterpython.utils import find_node_env, find_available_port
 from afterpython.const import CONTENT_TYPES
-from afterpython.utils import find_available_port, find_node_env
 
 
 @click.command(
@@ -108,6 +106,9 @@ def dev(
 
     paths = ctx.obj["paths"]
 
+    # OPTIMIZE: should implement incremental build?
+    subprocess.run(["ap", "build", "--dev"])
+
     def cleanup_processes():
         """Clean up all MyST server processes"""
         click.echo("\nShutting down MyST servers...")
@@ -138,14 +139,11 @@ def dev(
         enabled_content_types = {ct for ct, flag in content_flags.items() if flag}
 
     try:
-        prebuild()
-
-        # Clear .env.development before writing new ports
-        env_file = paths.website_path / ".env.development"
-        env_file.write_text("")  # Clear existing content
-
-        # myst development servers
         if enabled_content_types:
+            # Clear .env.development before writing new ports
+            env_file = paths.website_path / ".env.development"
+            env_file.write_text("")  # Clear existing content
+
             next_port = 3000
             for content_type in CONTENT_TYPES:
                 # Skip content types that are not enabled
@@ -187,8 +185,6 @@ def dev(
                 # causing "address already in use" errors.
                 time.sleep(3)
 
-        postbuild(dev_build=True)
-
         if not no_website:
             node_env: NodeEnv = find_node_env()
             click.echo("Running the web dev server...")

afterpython/cli/commands/format.py

@@ -13,7 +13,7 @@ from click.exceptions import Exit
 )
 @click.pass_context
 def format(ctx):
-    """Run ruff formatter"""
+    """Simple wrapper for ruff format for convenience"""
     from afterpython.utils import handle_passthrough_help
 
     # Show both our options and ruff's help and exit