afterpython 0.3.19__tar.gz → 0.4.1__tar.gz

{afterpython-0.3.19 → afterpython-0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: afterpython
-Version: 0.3.19
+Version: 0.4.1
 Summary: CLI tool to streamline Python package maintenance and generate a dedicated project website
 Keywords: package-maintenance,project-website,static-site-generator,developer-tools,documentation,cli-tool,ci/cd,mystmd,semantic-release,python-packaging
 Author: Stephen Yau
@@ -11,27 +11,31 @@ Classifier: Intended Audience :: Developers
 Classifier: Topic :: Software Development :: Build Tools
 Classifier: Topic :: Software Development :: Documentation
 Classifier: Typing :: Typed
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: click>=8.1.8
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Requires-Dist: click>=8.5.1
 Requires-Dist: trogon>=0.6.0
-Requires-Dist: httpx2>=2.5.0
-Requires-Dist: tomlkit>=0.15.0
+Requires-Dist: httpx2>=2.16.0
+Requires-Dist: tomlkit>=0.15.2
 Requires-Dist: ruamel-yaml>=0.19.1
-Requires-Dist: gitpython>=3.1.50
-Requires-Dist: python-dotenv>=1.2.2
-Requires-Dist: pyproject-metadata>=0.11.0
-Requires-Dist: jupytext>=1.19.4
-Requires-Dist: mystmd>=1.10.1
+Requires-Dist: gitpython>=3.2.1
+Requires-Dist: python-dotenv>=1.2.4
+Requires-Dist: pyproject-metadata>=0.12.1
+Requires-Dist: jupytext>=1.19.6
+Requires-Dist: mystmd>=1.12.0
 Requires-Dist: pdoc>=16.0.0
-Requires-Dist: ruff>=0.15.21
-Requires-Dist: pre-commit>=4.6.0
-Requires-Dist: commitizen>=4.16.4
-Requires-Python: >=3.11
+Requires-Dist: ruff>=0.17.4
+Requires-Dist: prek>=0.5.10
+Requires-Dist: ty>=0.0.99
+Requires-Dist: git-cliff>=2.14.2
+Requires-Dist: questionary>=2.1.1
+Requires-Dist: marimo[recommended,lsp]>=0.25.2 ; extra == 'marimo'
+Requires-Python: >=3.13
 Project-URL: homepage, https://afterpython.afterpython.org
 Project-URL: repository, https://github.com/AfterPythonOrg/afterpython
 Project-URL: documentation, https://afterpython.afterpython.org/doc
+Provides-Extra: marimo
 Description-Content-Type: text/markdown
 
 # AfterPython: Python Package Maintenance Toolkit and Project Website Generator
@@ -41,8 +45,8 @@ Description-Content-Type: text/markdown
 [![PyPI](https://img.shields.io/pypi/v/afterpython.svg?cacheSeconds=300)](https://pypi.org/project/afterpython)
 ![PyPI - Support Python Versions](https://img.shields.io/pypi/pyversions/afterpython?cacheSeconds=300)
 [![Discussions](https://img.shields.io/badge/Discussions-Let's%20Chat-green)](https://github.com/AfterPythonOrg/afterpython/discussions)
-[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/AfterPythonOrg/afterpython)
 [![View Code Wiki](https://assets.codewiki.google/readme-badge/static.svg)](https://codewiki.google/github.com/afterpythonorg/afterpython?utm_source=badge&utm_medium=github&utm_campaign=github.com/afterpythonorg/afterpython)
+<!--[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/AfterPythonOrg/afterpython)-->
 <!-- ![PyPI downloads](https://img.shields.io/pypi/dm/afterpython) -->
 <!-- [![Pixi Badge](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/prefix-dev/pixi/main/assets/badge/v0.json)](https://pixi.sh) -->
 
@@ -59,10 +63,10 @@ Description-Content-Type: text/markdown
 [Scikit-Learn]: https://scikit-learn.org
 [WebLLM]: https://webllm.mlc.ai/
 [project-website-template]: https://github.com/AfterPythonOrg/project-website-template
-[commitizen]: https://github.com/commitizen-tools/commitizen
 [uv]: https://docs.astral.sh/uv/
 [ruff]: https://docs.astral.sh/ruff/
-
+[ty]: https://docs.astral.sh/ty/
+[git-cliff]: https://git-cliff.org/
 
 ## Problem
 Going from **writing Python code to publishing and maintaining a package** is **time-consuming**.
@@ -125,10 +129,10 @@ ap tui
 - [pre-commit]
 - [GitHub Actions]
 - [pdoc]
-- [commitizen]
 - [uv]
 - [ruff]
+- [ty]
 - [pagefind]
 - [WebLLM]
-<!-- - ty -->
+- [git-cliff]
 <!-- - [pixi] -->

{afterpython-0.3.19 → afterpython-0.4.1}/README.md

@@ -5,8 +5,8 @@
 [![PyPI](https://img.shields.io/pypi/v/afterpython.svg?cacheSeconds=300)](https://pypi.org/project/afterpython)
 ![PyPI - Support Python Versions](https://img.shields.io/pypi/pyversions/afterpython?cacheSeconds=300)
 [![Discussions](https://img.shields.io/badge/Discussions-Let's%20Chat-green)](https://github.com/AfterPythonOrg/afterpython/discussions)
-[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/AfterPythonOrg/afterpython)
 [![View Code Wiki](https://assets.codewiki.google/readme-badge/static.svg)](https://codewiki.google/github.com/afterpythonorg/afterpython?utm_source=badge&utm_medium=github&utm_campaign=github.com/afterpythonorg/afterpython)
+<!--[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/AfterPythonOrg/afterpython)-->
 <!-- ![PyPI downloads](https://img.shields.io/pypi/dm/afterpython) -->
 <!-- [![Pixi Badge](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/prefix-dev/pixi/main/assets/badge/v0.json)](https://pixi.sh) -->
 
@@ -23,10 +23,10 @@
 [Scikit-Learn]: https://scikit-learn.org
 [WebLLM]: https://webllm.mlc.ai/
 [project-website-template]: https://github.com/AfterPythonOrg/project-website-template
-[commitizen]: https://github.com/commitizen-tools/commitizen
 [uv]: https://docs.astral.sh/uv/
 [ruff]: https://docs.astral.sh/ruff/
-
+[ty]: https://docs.astral.sh/ty/
+[git-cliff]: https://git-cliff.org/
 
 ## Problem
 Going from **writing Python code to publishing and maintaining a package** is **time-consuming**.
@@ -89,10 +89,10 @@ ap tui
 - [pre-commit]
 - [GitHub Actions]
 - [pdoc]
-- [commitizen]
 - [uv]
 - [ruff]
+- [ty]
 - [pagefind]
 - [WebLLM]
-<!-- - ty -->
+- [git-cliff]
 <!-- - [pixi] -->

{afterpython-0.3.19 → afterpython-0.4.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "afterpython"
-version = "0.3.19"
+version = "0.4.1"
 description = "CLI tool to streamline Python package maintenance and generate a dedicated project website"
 license = "Apache-2.0"
 readme = "README.md"
@@ -22,32 +22,37 @@ classifiers = [
     "Topic :: Software Development :: Build Tools",
     "Topic :: Software Development :: Documentation",
     "Typing :: Typed",
-    "Programming Language :: Python :: 3.11",
-    "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
 ]
-requires-python = ">=3.11"
+requires-python = ">=3.13"
 dependencies = [
-    "click>=8.1.8",
+    "click>=8.5.1",
     "trogon>=0.6.0",
-    "httpx2>=2.5.0",
-    "tomlkit>=0.15.0",
+    "httpx2>=2.16.0",
+    "tomlkit>=0.15.2",
     "ruamel-yaml>=0.19.1",
-    "gitpython>=3.1.50",
-    "python-dotenv>=1.2.2",
-    "pyproject-metadata>=0.11.0",
-    "jupytext>=1.19.4",
-    "mystmd>=1.10.1",
+    "gitpython>=3.2.1",
+    "python-dotenv>=1.2.4",
+    "pyproject-metadata>=0.12.1",
+    "jupytext>=1.19.6",
+    "mystmd>=1.12.0",
     "pdoc>=16.0.0",
-    "ruff>=0.15.21",
-    "pre-commit>=4.6.0",
-    "commitizen>=4.16.4",
+    "ruff>=0.17.4",
+    "prek>=0.5.10",
+    "ty>=0.0.99",
+    "git-cliff>=2.14.2",
+    "questionary>=2.1.1",
 ]
 
 [[project.authors]]
 name = "Stephen Yau"
 email = "softwareentrepreneer+afterpython@gmail.com"
 
+[project.optional-dependencies]
+marimo = ["marimo[recommended,lsp]>=0.25.2"]
+
 [project.urls]
 homepage = "https://afterpython.afterpython.org"
 repository = "https://github.com/AfterPythonOrg/afterpython"
@@ -58,15 +63,12 @@ ap = "afterpython.main:run_cli"
 pcu = "afterpython.main:run_pcu"
 
 [build-system]
-requires = ["uv_build>=0.11.28,<0.12.0"]
+requires = ["uv_build>=0.13.7,<0.14.0"]
 build-backend = "uv_build"
 
-[tool.uv]
-exclude-newer = "14 days"
-
 [tool.uv.build-backend]
 module-name = "afterpython"
 module-root = "src"
 
-[tool.pyright]
-typeCheckingMode = "basic"
+[tool.ruff]
+extend = "afterpython/ruff.toml"

{afterpython-0.3.19 → afterpython-0.4.1}/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "afterpython"
-version = "0.3.19"
+version = "0.4.1"
 description = "CLI tool to streamline Python package maintenance and generate a dedicated project website"
 license = "Apache-2.0"
 authors = [
@@ -25,32 +25,33 @@ classifiers = [
     "Topic :: Software Development :: Build Tools",
     "Topic :: Software Development :: Documentation",
     "Typing :: Typed",
-    "Programming Language :: Python :: 3.11",
-    "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
-    # "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
 ]
-requires-python = ">=3.11"
+requires-python = ">=3.13"
 dependencies = [
-    "click>=8.1.8",
+    "click>=8.5.1",
     "trogon>=0.6.0",
-    "httpx2>=2.5.0",
-    "tomlkit>=0.15.0",
+    "httpx2>=2.16.0",
+    "tomlkit>=0.15.2",
     "ruamel-yaml>=0.19.1",
-    "gitpython>=3.1.50",
-    # "pygithub>=2.8.1",
-    "python-dotenv>=1.2.2",
-    "pyproject-metadata>=0.11.0",
-    "jupytext>=1.19.4",
-    # "jinja2>=3.1.6",
-    "mystmd>=1.10.1",
+    "gitpython>=3.2.1",
+    "python-dotenv>=1.2.4",
+    "pyproject-metadata>=0.12.1",
+    "jupytext>=1.19.6",
+    "mystmd>=1.12.0",
     "pdoc>=16.0.0",
-    "ruff>=0.15.21",
-    "pre-commit>=4.6.0",
-    "commitizen>=4.16.4",
-    # "python-semantic-release>=10.5.2",
+    "ruff>=0.17.4",
+    "prek>=0.5.10",
+    "ty>=0.0.99",
+    "git-cliff>=2.14.2",
+    "questionary>=2.1.1",
 ]
 
+[project.optional-dependencies]
+marimo = ["marimo[recommended,lsp]>=0.25.2"]
+
 [project.urls]
 homepage = "https://afterpython.afterpython.org"
 repository = "https://github.com/AfterPythonOrg/afterpython"
@@ -60,22 +61,16 @@ documentation = "https://afterpython.afterpython.org/doc"
 ap = "afterpython.main:run_cli"
 pcu = "afterpython.main:run_pcu"
 
-# [tool.uv]
-# override-dependencies = ["platformdirs>=4.5.0", "nodeenv>=1.9.1"]
-
 [build-system]
-requires = ["uv_build>=0.11.28,<0.12.0"]
+requires = ["uv_build>=0.13.7,<0.14.0"]
 build-backend = "uv_build"
 
 [tool.uv]
-exclude-newer = "14 days"
+# exclude-newer = "14 days"
 
 [tool.uv.build-backend]
 module-name = "afterpython"
 module-root = "src"
 
-# [tool.uv.sources]
-# afterpython = { path = ".", editable = true }
-
-[tool.pyright]
-typeCheckingMode = "basic"
+[tool.ruff]
+extend = "afterpython/ruff.toml"

afterpython-0.4.1/src/afterpython/_typing.py

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

{afterpython-0.3.19 → afterpython-0.4.1}/src/afterpython/builders/__init__.py

@@ -1,4 +1,5 @@
 from afterpython.builders.build_pdoc import build_pdoc
+from afterpython.builders.comments_json import build_comments_json
 from afterpython.builders.content_json import build_content_json
 from afterpython.builders.faq_json import build_faq_json
 from afterpython.builders.index_md import (
@@ -13,6 +14,7 @@ from afterpython.builders.metadata import build_metadata
 from afterpython.builders.url_md import build_url_md
 
 __all__ = (
+    "build_comments_json",
     "build_content_json",
     "build_faq_json",
     "build_jupyter_notebooks",

{afterpython-0.3.19 → afterpython-0.4.1}/src/afterpython/builders/build_pdoc.py

@@ -19,9 +19,15 @@ def build_pdoc(base_path: str) -> None:
     project logo appears in the top-left of every API page and links
     back to the project website root (matches MyST's UX).
     """
+    from afterpython._io.toml import _from_tomlkit
+    from afterpython.tools._afterpython import read_afterpython
+
     package_dir = find_package_directory()
     output_dir = ap.paths.build_path / "api_reference"
     template_dir = ap.paths.templates_path / "pdoc"
+    # e.g. "google"; unset leaves it to pdoc (a module's __docformat__, else restructuredtext)
+    website = _from_tomlkit(read_afterpython().get("website", {}))
+    docformat = website.get("api_reference_docformat")
 
     click.echo("Building api_reference/...")
 
@@ -45,6 +51,7 @@ def build_pdoc(base_path: str) -> None:
             f"{base_path}/",
             "--template-directory",
             str(template_dir),
+            *(["--docformat", str(docformat)] if docformat else []),
             str(package_dir),
         ],
         env=env,

afterpython-0.4.1/src/afterpython/builders/comments_json.py

@@ -0,0 +1,107 @@
+from __future__ import annotations
+
+import json
+import re
+
+import click
+
+import afterpython as ap
+
+GISCUS_API = "https://giscus.app/api/discussions/categories"
+DEFAULT_CATEGORY = "Announcements"
+
+
+def _read_comments_config() -> dict:
+    from afterpython._io.toml import _from_tomlkit
+    from afterpython.tools._afterpython import read_afterpython
+
+    website = _from_tomlkit(read_afterpython().get("website", {}))
+    return dict(website.get("comments", {}))
+
+
+def _get_github_repo() -> str | None:
+    """Return "owner/repo" from pyproject.toml's repository URL, or the git remote."""
+    from afterpython.tools._git import get_github_url
+    from afterpython.tools.pyproject import read_metadata
+
+    url = str(read_metadata().urls.get("repository", "")) or get_github_url() or ""
+    match = re.search(r"github\.com[/:]([^/]+)/([^/]+?)(?:\.git)?/?$", url)
+    return f"{match[1]}/{match[2]}" if match else None
+
+
+def _fetch_giscus_categories(repo: str) -> dict:
+    """Fetch the repo and category IDs giscus needs. Raises click.ClickException on failure."""
+    import httpx2
+
+    try:
+        response = httpx2.get(GISCUS_API, params={"repo": repo}, timeout=10.0)
+    except httpx2.HTTPError as e:
+        raise click.ClickException(f"could not reach giscus.app ({e})") from e
+    try:
+        data = response.json()
+    except ValueError:
+        data = {}
+    if response.status_code != 200 or "repositoryId" not in data:
+        error = data.get("error") or f"HTTP {response.status_code}"
+        raise click.ClickException(error)
+    return data
+
+
+def build_comments_json():
+    """Build comments.json for the giscus comment section on content pages.
+
+    Reads [website.comments] in afterpython.toml. The website template only
+    shows comments when comments.json exists, so a disabled or failed setup
+    just leaves it out. Never fails the build.
+    """
+    stale = ap.paths.website_path / "static" / "comments.json"
+    stale.unlink(missing_ok=True)
+
+    config = _read_comments_config()
+    if not config.get("enabled", False):
+        click.echo("Comments are disabled, skip building comments.json")
+        return
+
+    def warn(reason: str):
+        click.secho(f"Warning: skip comments, {reason}", fg="yellow")
+
+    repo = _get_github_repo()
+    if not repo:
+        warn(
+            "no GitHub repository found "
+            "(set [project.urls] repository in pyproject.toml)"
+        )
+        return
+
+    category = str(config.get("category") or DEFAULT_CATEGORY)
+    try:
+        data = _fetch_giscus_categories(repo)
+    except click.ClickException as e:
+        warn(
+            f"giscus is not ready for {repo}: {e.message}\n"
+            f"  1. Enable Discussions: https://github.com/{repo}/settings\n"
+            "  2. Install the giscus app: https://github.com/apps/giscus\n"
+            "  Or set [website.comments] enabled = false in afterpython.toml"
+        )
+        return
+
+    category_id = next(
+        (c["id"] for c in data.get("categories", []) if c["name"] == category), None
+    )
+    if not category_id:
+        names = ", ".join(c["name"] for c in data.get("categories", []))
+        warn(
+            f'Discussions category "{category}" not found in {repo} '
+            f"(available: {names or 'none'})"
+        )
+        return
+
+    click.echo(f"Building comments.json ({repo}, {category})...")
+    comments = {
+        "repo": repo,
+        "repoId": data["repositoryId"],
+        "category": category,
+        "categoryId": category_id,
+    }
+    with open(ap.paths.build_path / "comments.json", "w") as f:
+        json.dump(comments, f, indent=2)

{afterpython-0.3.19 → afterpython-0.4.1}/src/afterpython/builders/marimo_notebook.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import os
 import re
+import shutil
 import subprocess
 from pathlib import Path
 from typing import Literal
@@ -48,6 +49,12 @@ def _export_marimo(
     execute: bool = False,
 ):
     """Run `marimo export` to produce HTML at `output_html`."""
+    # marimo is an optional dependency (the `marimo` extra)
+    if shutil.which("marimo") is None:
+        raise click.ClickException(
+            f"marimo is required to build {source.name} (a marimo notebook), "
+            'install it with: uv add --dev "afterpython[marimo]"'
+        )
     output_html.parent.mkdir(parents=True, exist_ok=True)
     subcommand = "html-wasm" if mode == "wasm" else "html"
     cmd = [

{afterpython-0.3.19 → afterpython-0.4.1}/src/afterpython/cli/commands/build.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from collections.abc import Callable
+from collections.abc import Callable, Iterable
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
@@ -17,6 +17,7 @@ from click.exceptions import Exit
 
 import afterpython as ap
 from afterpython.builders import (
+    build_comments_json,
     build_content_json,
     build_faq_json,
     build_jupyter_notebooks,
@@ -137,6 +138,7 @@ def prebuild():
     create_placeholder_index_md_files()
     build_metadata()
     build_faq_json()
+    build_comments_json()
     build_marimo_readme(mode=_get_readme_py_mode())
     build_markdown()
     build_jupyter_notebooks()
@@ -147,7 +149,7 @@ def postbuild(dev_build: bool = False):
         source: Path,
         destination: Path,
         is_copy: bool = True,
-        ignore_copy: Callable[[str, list[str]], set[str]] | None = None,
+        ignore_copy: Callable[[str, list[str]], Iterable[str]] | None = None,
     ):
         """
         Move or copy files from source to destination.
@@ -156,7 +158,7 @@ def postbuild(dev_build: bool = False):
             source: Source path
             destination: Destination path
             is_copy: If True, copy files (merge with existing). If False, move files (replace destination)
-            ignore_copy: Optional ignore function for copytree, takes (directory, contents) and returns set of names to ignore
+            ignore_copy: Optional ignore function for copytree, takes (directory, contents) and returns the names to ignore
         """
         if not source.exists():
             return