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

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(
@@ -29,61 +27,19 @@ from afterpython.utils import find_available_port, find_node_env
     is_flag=True,
     help="Start the development server for all content types and the project website",
 )
-@click.option(
-    "--doc",
-    is_flag=True,
-    help="Start the development server for documentation content",
-)
-@click.option(
-    "--blog",
-    is_flag=True,
-    help="Start the development server for blog content",
-)
-@click.option(
-    "--tutorial",
-    is_flag=True,
-    help="Start the development server for tutorial content",
-)
-@click.option(
-    "--example",
-    is_flag=True,
-    help="Start the development server for example content",
-)
-@click.option(
-    "--guide",
-    is_flag=True,
-    help="Start the development server for guide content",
-)
 @click.option(
     "--execute", is_flag=True, help="Execute Jupyter notebooks for all content types"
 )
 @click.option(
     "--no-website",
-    "-n",
     is_flag=True,
     help="Skip running the website dev server (pnpm dev). Useful when you want to run pnpm dev manually with custom options.",
 )
-def dev(
-    ctx,
-    all: bool,
-    doc: bool,
-    blog: bool,
-    tutorial: bool,
-    example: bool,
-    guide: bool,
-    execute: bool,
-    no_website: bool,
-):
+def dev(ctx, all: bool, execute: bool, no_website: bool):
     """Run the development server for the project website.
 
-    By default, runs only the website without any content servers.
-    Use --all to start all content types, or specify individual content types with --doc, --blog, etc.
-
-    Examples:
-      ap dev              # Website only
-      ap dev --all        # Website + all content types
-      ap dev --doc        # Website + doc content
-      ap dev --doc --blog # Website + doc and blog content
+    If --all is enabled, starts MyST dev servers for all content types (doc/blog/tutorial/example/guide)
+    and the project website.
 
     Any extra arguments are passed to the MyST servers (via 'ap doc/blog/tutorial/example/guide' commands).
     See "myst start --help" for more details.
@@ -108,6 +64,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...")
@@ -120,38 +79,14 @@ def dev(
             except Exception:
                 pass
 
-    # Determine which content types to run
-    if all:
-        enabled_content_types = set(CONTENT_TYPES)
-    else:
-        # Check individual flags
-        content_flags = {
-            "doc": doc,
-            "blog": blog,
-            "tutorial": tutorial,
-            "example": example,
-            "guide": guide,
-        }
-        assert set(content_flags.keys()) == set(CONTENT_TYPES), (
-            "Incomplete content flags"
-        )
-        enabled_content_types = {ct for ct, flag in content_flags.items() if flag}
-
     try:
-        prebuild()
+        if all:
+            # Clear .env.development before writing new ports
+            env_file = paths.website_path / ".env.development"
+            env_file.write_text("")  # Clear existing content
 
-        # 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:
             next_port = 3000
             for content_type in CONTENT_TYPES:
-                # Skip content types that are not enabled
-                if content_type not in enabled_content_types:
-                    continue
-
                 # Find available port for MyST server
                 myst_port = find_available_port(start_port=next_port)
                 next_port = myst_port + 1
@@ -187,8 +122,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...")
@@ -201,7 +134,7 @@ def dev(
             click.echo(
                 "Skipping website dev server (--no-website flag). Run 'pnpm dev' manually in afterpython/_website/ with your custom options."
             )
-            if enabled_content_types:
+            if all:
                 # Keep the process running to maintain MyST servers
                 click.echo("Press Ctrl+C to stop MyST servers...")
                 while True:

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

afterpython/cli/commands/init.py

@@ -7,13 +7,38 @@ import afterpython as ap
 
 
 def init_ruff_toml():
-    ruff_toml_path = ap.paths.afterpython_path / "ruff.toml"
+    from afterpython.tools.pre_commit import update_pre_commit
+
+    afterpython_path = ap.paths.afterpython_path
+    ruff_toml_path = afterpython_path / "ruff.toml"
     if ruff_toml_path.exists():
         click.echo(f"Ruff configuration file {ruff_toml_path} already exists")
         return
     ruff_template_path = ap.paths.templates_path / "ruff-template.toml"
     shutil.copy(ruff_template_path, ruff_toml_path)
     click.echo(f"Created {ruff_toml_path}")
+    # add ruff-pre-commit hook to .pre-commit-config.yaml
+    data_update = {
+        "repos": [
+            {
+                "repo": "https://github.com/astral-sh/ruff-pre-commit",
+                "rev": "v0.14.5",
+                "hooks": [
+                    {
+                        "id": "ruff-check",
+                        "stages": ["pre-commit"],
+                        "args": ["--config", "./afterpython/ruff.toml"],
+                    },
+                    {
+                        "id": "ruff-format",
+                        "stages": ["pre-commit"],
+                        "args": ["--config", "./afterpython/ruff.toml"],
+                    },
+                ],
+            },
+        ]
+    }
+    update_pre_commit(data_update)
 
 
 def init_website():
@@ -21,43 +46,19 @@ def init_website():
     subprocess.run(["ap", "update", "website"])
 
 
-def init_py_typed():
-    from afterpython.tools.pyproject import find_package_directory
-
-    try:
-        package_dir = find_package_directory()
-    except FileNotFoundError:
-        click.echo(
-            "Could not find package directory (__init__.py not found), skipping py-typed initialization"
-        )
-        return
-    py_typed_path = package_dir / "py.typed"
-    if py_typed_path.exists():
-        click.echo(f"py.typed file already exists at {py_typed_path}")
-        return
-    py_typed_path.touch()
-    click.echo(f"Created {py_typed_path}")
-
-
 @click.command()
-@click.option(
-    "--yes",
-    "-y",
-    is_flag=True,
-    help="Automatically answer yes to all prompts",
-)
 @click.pass_context
-def init(ctx, yes):
-    """Initialize AfterPython project structure and website template"""
+def init(ctx):
+    """Initialize afterpython with MyST Markdown (by default) and project website template"""
+    from afterpython.tools.pyproject import init_pyproject
     from afterpython.tools._afterpython import init_afterpython
+    from afterpython.tools.myst import init_myst
+    from afterpython.tools.pre_commit import init_pre_commit
     from afterpython.tools.commitizen import init_commitizen
     from afterpython.tools.github_actions import (
-        create_dependabot,
-        create_workflow,
+        init_release_workflow,
+        init_deploy_workflow,
     )
-    from afterpython.tools.myst import init_myst
-    from afterpython.tools.pre_commit import init_pre_commit
-    from afterpython.tools.pyproject import init_pyproject
 
     paths = ctx.obj["paths"]
     click.echo("Initializing afterpython...")
@@ -66,6 +67,7 @@ def init(ctx, yes):
 
     afterpython_path.mkdir(parents=True, exist_ok=True)
     static_path.mkdir(parents=True, exist_ok=True)
+    afterpython_path.joinpath("afterpython.toml").touch()
 
     init_pyproject()
 
@@ -77,31 +79,20 @@ def init(ctx, yes):
 
     init_website()
 
-    # TODO: add type checking related stuff here
-    init_py_typed()
-
-    create_workflow("deploy")
-    create_workflow("ci")
-
-    if yes or click.confirm(
+    if click.confirm(
         f"\nCreate .pre-commit-config.yaml in {afterpython_path}?", default=True
     ):
         init_pre_commit()
 
-    if yes or click.confirm(f"\nCreate ruff.toml in {afterpython_path}?", default=True):
+    if click.confirm(f"\nCreate ruff.toml in {afterpython_path}?", default=True):
         init_ruff_toml()
 
-    if yes or click.confirm(
+    if click.confirm(
         f"\nCreate commitizen configuration (cz.toml) in {afterpython_path} "
         f"and release workflow in .github/workflows/release.yml?",
         default=True,
     ):
         init_commitizen()
-        create_workflow("release")
+        init_release_workflow()
 
-    if yes or click.confirm(
-        "\nCreate Dependabot configuration (.github/dependabot.yml) "
-        "to auto-update GitHub Actions versions?",
-        default=True,
-    ):
-        create_dependabot()
+    init_deploy_workflow()

afterpython/cli/commands/install.py

@@ -3,7 +3,7 @@ import subprocess
 import click
 from click.exceptions import Exit
 
-from afterpython.utils import has_pixi, has_uv
+from afterpython.utils import has_uv
 
 
 @click.command(
@@ -13,16 +13,10 @@ from afterpython.utils import has_pixi, has_uv
     )
 )
 def install():
-    """Install all project dependencies (manages both uv and pixi if present)"""
+    """Run 'uv sync --all-extras --all-groups' to install all dependencies"""
     if not has_uv():
         click.echo("uv not found. Please install uv first.")
         return
-
     result = subprocess.run(["uv", "sync", "--all-extras", "--all-groups"], check=False)
     if result.returncode != 0:
         raise Exit(result.returncode)
-
-    if has_pixi():
-        result = subprocess.run(["pixi", "install"], check=False)
-        if result.returncode != 0:
-            raise Exit(result.returncode)

afterpython/cli/commands/pre_commit.py

@@ -27,7 +27,7 @@ def _command_supports_config(command: str) -> bool:
 )
 @click.pass_context
 def pre_commit(ctx):
-    """Run pre-commit hooks (uses afterpython/.pre-commit-config.yaml if available)"""
+    """Run pre-commit, always use the afterpython/.pre-commit-config.yaml if it exists"""
     from afterpython.utils import handle_passthrough_help
 
     # Show both our options and pre-commit's help and exit

afterpython/cli/commands/preview.py

@@ -7,7 +7,7 @@ from click.exceptions import Exit
 @click.command()
 @click.pass_context
 def preview(ctx):
-    """Preview the production build of the project website"""
+    """Preview the production build of the project website (including myst's builds)"""
     from afterpython.utils import find_node_env
 
     paths = ctx.obj["paths"]

afterpython/cli/commands/start.py

@@ -1,5 +1,4 @@
 from __future__ import annotations
-
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
@@ -10,13 +9,13 @@ import subprocess
 import click
 from click.exceptions import Exit
 
+
 command_kwargs = {
     "add_help_option": False,  # disable click's --help option so that myst start --help can work
     "context_settings": dict(
         ignore_unknown_options=True,
         allow_extra_args=True,
     ),
-    "hidden": True,  # Hide these commands from help output
 }
 
 
@@ -42,13 +41,10 @@ command_kwargs = {
     "--guide", is_flag=True, help="Start the development server for guide/ directory"
 )
 def start(ctx, doc: bool, blog: bool, tutorial: bool, example: bool, guide: bool):
-    """Start MyST development server for a specific content type"""
+    """Simple wrapper for `myst start` for convenience"""
+    from afterpython.utils import find_node_env, has_content_for_myst
     from afterpython.const import CONTENT_TYPES
-    from afterpython.utils import (
-        find_node_env,
-        handle_passthrough_help,
-        has_content_for_myst,
-    )
+    from afterpython.utils import handle_passthrough_help
 
     # Show both our options and myst's help and exit
     handle_passthrough_help(

afterpython/cli/commands/sync.py

@@ -2,16 +2,15 @@ from datetime import datetime
 
 import click
 from pyproject_metadata import StandardMetadata
-from tomlkit.toml_document import TOMLDocument
 
 import afterpython as ap
-from afterpython.utils import convert_author_name_to_id, normalize_static_path
+from afterpython.utils import convert_author_name_to_id
 
 
 def _sync_authors_yml(authors: list[tuple[str, str | None]]):
     """Sync authors.yml with authors in pyproject.toml"""
-    from afterpython._io.yaml import read_yaml
     from afterpython.tools.myst import update_authors_yml
+    from afterpython._io.yaml import read_yaml
 
     # read myst.yml from docs path to get "version"
     doc_myst_yml = read_yaml(ap.paths.afterpython_path / "doc" / "myst.yml")
@@ -36,73 +35,40 @@ def _sync_authors_yml(authors: list[tuple[str, str | None]]):
 
 @click.command()
 def sync():
-    """Sync configuration between pyproject.toml/afterpython.toml and authors.yml/myst.yml"""
-    from afterpython._io.toml import _from_tomlkit
+    """Sync between pyproject.toml+afterpython.toml and authors.yml+myst.yml files"""
     from afterpython.const import CONTENT_TYPES
     from afterpython.tools._afterpython import read_afterpython
+    from afterpython.tools.pyproject import read_metadata
+    from afterpython._io.toml import _from_tomlkit
     from afterpython.tools.myst import update_myst_yml
-    from afterpython.tools.pyproject import (
-        read_metadata,
-        read_pyproject,
-        write_pyproject,
-    )
 
     pyproject: StandardMetadata = read_metadata()
     project_name = str(pyproject.name)
     afterpython = read_afterpython()
     github_url = str(pyproject.urls.get("repository", ""))
-    company_name = str(_from_tomlkit(afterpython.get("company", {})).get("name", ""))
-    company_url = str(_from_tomlkit(afterpython.get("company", {})).get("url", ""))
-    website_url = str(_from_tomlkit(afterpython.get("website", {})).get("url", ""))
-    try:
-        website_favicon = normalize_static_path(
-            str(_from_tomlkit(afterpython.get("website", {})).get("favicon", ""))
-        )
-        website_logo = normalize_static_path(
-            str(_from_tomlkit(afterpython.get("website", {})).get("logo", ""))
-        )
-        website_logo_dark = normalize_static_path(
-            str(_from_tomlkit(afterpython.get("website", {})).get("logo_dark", ""))
-        )
-        website_thumbnail = normalize_static_path(
-            str(_from_tomlkit(afterpython.get("website", {})).get("thumbnail", ""))
-        )
-    except ValueError as e:
-        click.echo(f"Error in reading afterpython.toml: {e}")
-        return
-
+    company_name = str(_from_tomlkit(afterpython["company"]).get("name", ""))
+    company_url = str(_from_tomlkit(afterpython["company"]).get("url", ""))
+    website_url = str(_from_tomlkit(afterpython["website"]).get("url", ""))
     authors = pyproject.authors
-    if company_name and company_url:
-        nav_bar = [{"title": company_name, "url": company_url}]
-    else:
-        nav_bar = []
-    if website_url:
-        nav_bar.extend(
-            [
-                {
-                    "title": content_type.capitalize() + "s",
-                    "url": f"{website_url}/{content_type}",
-                }
-                for content_type in CONTENT_TYPES
-            ]
-        )
+    nav_bar = [
+        {
+            "title": content_type.capitalize() + "s",
+            "url": f"{website_url}/{content_type}",
+        }
+        if website_url
+        else ""
+        for content_type in CONTENT_TYPES
+    ]
 
     _sync_authors_yml(authors)
 
-    # update "homepage", "repository", and "documentation" in pyproject.toml
-    if website_url:
-        doc: TOMLDocument = read_pyproject()
-        doc["project"]["urls"]["homepage"] = website_url
-        doc["project"]["urls"]["documentation"] = f"{website_url}/doc"
-        write_pyproject(doc)
-
     # update myst.yml files for each content type (e.g. doc/, blog/, tutorial/, example/, guide/)
     # based on the current values in pyproject.toml and afterpython.toml
     for content_type in CONTENT_TYPES:
         path = ap.paths.afterpython_path / content_type
-        # nav_bar_per_content_type = [
-        #     item for item in nav_bar if item["title"] != content_type.capitalize() + "s"
-        # ]
+        nav_bar_per_content_type = [
+            item for item in nav_bar if item["title"] != content_type.capitalize()
+        ]
         title = project_name + f"'s {content_type.capitalize()}"
         data = {
             "project": {
@@ -120,24 +86,14 @@ def sync():
                 "description": str(pyproject.description),
                 "keywords": list(map(str, pyproject.keywords)),
                 "github": github_url,
-                "thumbnail": "../static" + website_thumbnail
-                if website_thumbnail
-                else "",
             },
             "site": {
                 "title": title,
                 "options": {
-                    "favicon": "../static" + website_favicon if website_favicon else "",
-                    "logo": "../static" + website_logo if website_logo else "",
-                    "logo_dark": "../static" + website_logo_dark
-                    if website_logo_dark
-                    else "",
                     "logo_text": project_name,
                     "logo_url": website_url,
                 },
-                # FIXME: disable nav bar for now until myst fixes the issue with the nav bar
-                # the current issue is they prepend the BASE_URL to the nav bar links even they are external
-                # "nav": nav_bar_per_content_type,
+                "nav": nav_bar_per_content_type,
                 "actions": [
                     {
                         "title": "⭐ Star",

afterpython/cli/commands/update.py

@@ -1,13 +1,12 @@
 from __future__ import annotations
-
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
     from afterpython._typing import NodeEnv
     from afterpython.pcu import Dependencies
 
-import shutil
 import subprocess
+import shutil
 
 import click
 from click.exceptions import Exit
@@ -24,17 +23,17 @@ def update():
     "-u",
     "--upgrade",
     is_flag=True,
-    help="Upgrade dependencies to their latest versions",
+    help="if enabled, the dependencies will be upgraded to the latest version",
 )
 @click.option(
     "--all",
     is_flag=True,
-    help="Also update pre-commit hooks and pixi dependencies",
+    help="update all versions in dependencies and tool configurations (e.g. pre-commit-config.yaml)",
 )
 def dependencies(upgrade: bool, all: bool):
-    """Check and update project dependencies to latest versions"""
+    """Update pyproject.toml dependencies to the latest version"""
     from afterpython.pcu import get_dependencies, update_dependencies
-    from afterpython.utils import has_pixi, has_uv
+    from afterpython.utils import has_uv
 
     dependencies: Dependencies = get_dependencies()
     has_at_least_one_update = False
@@ -80,9 +79,7 @@ def dependencies(upgrade: bool, all: bool):
                 raise Exit(result.returncode)
             click.echo(
                 click.style(
-                    "✓ All dependencies in pyproject.toml upgraded successfully 🎉",
-                    fg="green",
-                    bold=True,
+                    "✓ All dependencies upgraded successfully 🎉", fg="green", bold=True
                 )
             )
         else:
@@ -92,26 +89,6 @@ def dependencies(upgrade: bool, all: bool):
     if all:
         subprocess.run(["ap", "pre-commit", "autoupdate"])
         click.echo("All pre-commit hooks updated successfully.")
-        if has_pixi():
-            click.echo("Upgrading dependencies with pixi...")
-            result = subprocess.run(
-                ["pixi", "upgrade", "--exclude", "python"], check=False
-            )
-            if result.returncode != 0:
-                raise Exit(result.returncode)
-            result = subprocess.run(["pixi", "lock"], check=False)
-            if result.returncode != 0:
-                raise Exit(result.returncode)
-            result = subprocess.run(["pixi", "install"], check=False)
-            if result.returncode != 0:
-                raise Exit(result.returncode)
-            click.echo(
-                click.style(
-                    "✓ All dependencies in pixi.toml upgraded successfully 🎉",
-                    fg="green",
-                    bold=True,
-                )
-            )
 
 
 update.add_command(dependencies, name="deps")  # alias for "dependencies"
@@ -122,10 +99,10 @@ update.add_command(dependencies, name="deps")  # alias for "dependencies"
 @click.option(
     "--no-backup",
     is_flag=True,
-    help="Skip creating a backup of the existing website template",
+    help="if enabled, the existing project website template will not be backed up",
 )
 def website(ctx, no_backup: bool):
-    """Update project website template to the latest version"""
+    """Update the project website template to the latest version"""
     from afterpython.utils import find_node_env
 
     website_template_repo = "AfterPythonOrg/project-website-template"