nbdevAuto 0.3.63__tar.gz → 0.3.64__tar.gz

{nbdevauto-0.3.63/nbdevAuto.egg-info → nbdevauto-0.3.64}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nbdevAuto
-Version: 0.3.63
+Version: 0.3.64
 Summary: automating nbdev
 Author-email: Benedict Thekkel <bthekkel1@gmail.com>
 License-Expression: Apache-2.0
@@ -23,6 +23,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: graphviz
 Requires-Dist: fastcore
+Requires-Dist: rich
 Provides-Extra: gh
 Requires-Dist: githubkit>=0.12; extra == "gh"
 Dynamic: license-file

nbdevauto-0.3.64/nbdevAuto/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.3.64"

{nbdevauto-0.3.63 → nbdevauto-0.3.64}/nbdevAuto/_modidx.py

@@ -5,7 +5,12 @@ d = { 'settings': { 'branch': 'main',
                 'doc_host': 'https://bthek1.github.io',
                 'git_url': 'https://github.com/bthek1/nbdevAuto',
                 'lib_path': 'nbdevAuto'},
-  'syms': { 'nbdevAuto.automate': { 'nbdevAuto.automate.gacp': ('automate.html#gacp', 'nbdevAuto/automate.py'),
+  'syms': { 'nbdevAuto.automate': { 'nbdevAuto.automate._banner': ('automate.html#_banner', 'nbdevAuto/automate.py'),
+                                    'nbdevAuto.automate._done': ('automate.html#_done', 'nbdevAuto/automate.py'),
+                                    'nbdevAuto.automate._dur': ('automate.html#_dur', 'nbdevAuto/automate.py'),
+                                    'nbdevAuto.automate._status_table': ('automate.html#_status_table', 'nbdevAuto/automate.py'),
+                                    'nbdevAuto.automate._step': ('automate.html#_step', 'nbdevAuto/automate.py'),
+                                    'nbdevAuto.automate.gacp': ('automate.html#gacp', 'nbdevAuto/automate.py'),
                                     'nbdevAuto.automate.help_output': ('automate.html#help_output', 'nbdevAuto/automate.py'),
                                     'nbdevAuto.automate.prep': ('automate.html#prep', 'nbdevAuto/automate.py'),
                                     'nbdevAuto.automate.release': ('automate.html#release', 'nbdevAuto/automate.py'),

nbdevauto-0.3.64/nbdevAuto/automate.py

@@ -0,0 +1,209 @@
+"""Automate
+
+Docs: https://bthek1.github.io/nbdevAuto/automate.html.md"""
+
+# AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/01_Automate.ipynb.
+
+# %% auto #0
+__all__ = ['prep', 'gacp', 'status', 'upload', 'release_git', 'release_pypi', 'release', 'help_output']
+
+# %% ../nbs/01_Automate.ipynb #6d1499d1-aa55-47d8-92fd-fa056b1fb135
+from fastcore.script import *
+from rich import box
+from rich.console import Console
+from rich.markup import escape
+from rich.table import Table
+
+# %% ../nbs/01_Automate.ipynb #7c1e5a90-3f52-4d21-9b6a-2c0f4e8d1a37
+from contextlib import contextmanager
+from time import perf_counter
+
+from nbdevAuto import __version__
+
+console = Console()
+
+# `git status -s` codes: colour, and the word for the third column.
+_CODE_STYLE = {"M":"yellow", "A":"green", "D":"red", "R":"cyan", "C":"cyan", "U":"magenta", "?":"dim"}
+_CODE_LABEL = {"M":"modified", "A":"added", "D":"deleted", "R":"renamed", "C":"copied",
+               "U":"conflict", "?":"untracked"}
+
+def _dur(t0):
+    "Elapsed time since `t0`, at a readable scale"
+    s = perf_counter() - t0
+    if s < 1:  return f"{s*1000:.0f}ms"
+    if s < 60: return f"{s:.1f}s"
+    return f"{int(s)//60}m{int(s)%60:02d}s"
+
+def _banner(cmd):
+    "Command header, with the package version alongside"
+    console.rule(f"[bold cyan]{cmd}[/bold cyan] [dim]nbdevAuto {__version__}[/dim]", style="cyan")
+
+def _done(cmd, t0):
+    "Closing summary for a multi-stage command"
+    console.rule(f"[green]{cmd} finished[/green] [dim]in {_dur(t0)}[/dim]", style="green")
+
+@contextmanager
+def _step(n, total, label):
+    "Run one stage, reporting its outcome and duration. Re-raises so nothing is swallowed"
+    console.print(f"[dim]{n}/{total}[/dim] [bold]{label}[/bold]")
+    t0 = perf_counter()
+    try:
+        yield
+    except BaseException:
+        console.print(f"    [bold red]FAIL[/bold red] [dim]{_dur(t0)}[/dim]\n")
+        raise
+    console.print(f"    [green]OK[/green]   [dim]{_dur(t0)}[/dim]\n")
+
+def _status_table(porcelain):
+    "Render `git status -s` output as a table, one row per path"
+    t = Table(box=box.SIMPLE, show_header=False, pad_edge=False, expand=False)
+    t.add_column("code", no_wrap=True, justify="right")
+    t.add_column("path", overflow="fold")
+    t.add_column("what", style="dim", no_wrap=True)
+    n = 0
+    for line in porcelain.splitlines():
+        if not line.strip(): continue
+        code, path = line[:2].strip(), line[3:]
+        style = _CODE_STYLE.get(code[:1], "white")
+        t.add_row(f"[{style}]{code}[/{style}]", escape(path), _CODE_LABEL.get(code[:1], ""))
+        n += 1
+    return t, n
+
+# %% ../nbs/01_Automate.ipynb #3a6f81d2-5c47-4e19-8b03-9d2a7f6c0e15
+@call_parse
+def prep(
+    p:int = 2, # Increment Part
+):
+    "Bump version part `p`, then export, test and clean the notebooks, refreshing _quarto.yml and README"
+
+    import nbdev.test, nbdev.clean, nbdev.quarto, nbdev.release
+    _banner("prep")
+    t0 = perf_counter()
+    with _step(1, 6, f"bump version (part {p})"):
+        nbdev.release.nbdev_bump_version(p)
+    with _step(2, 6, "nbdev_export"):
+        nbdev.quarto.nbdev_export.__wrapped__()
+    with _step(3, 6, "nbdev_test"):
+        nbdev.test.nbdev_test.__wrapped__(
+            n_workers = 8,  # Number of workers
+            timing = True,  # Time each notebook to see which are slow
+        )
+    with _step(4, 6, "nbdev_clean"):
+        nbdev.clean.nbdev_clean.__wrapped__()
+    with _step(5, 6, "refresh_quarto_yml"):
+        nbdev.quarto.refresh_quarto_yml()
+    with _step(6, 6, "nbdev_readme"):
+        nbdev.quarto.nbdev_readme.__wrapped__(chk_time=True)
+    _done("prep", t0)
+
+# %% ../nbs/01_Automate.ipynb #f66ef35f-b7fa-4039-aa07-e9b782d204bb
+@call_parse
+def gacp(
+    m:str = '', # Commit message
+):
+    "git add, commit and push. Without `-m` the commit message is the status output"
+
+    import subprocess
+    _banner("gacp")
+    t0 = perf_counter()
+    with _step(1, 3, "git add"):
+        subprocess.run(["git", "add", "."])
+    status = subprocess.check_output(["git", "status", "-s"]).decode('utf-8')
+    if status.strip():
+        table, n = _status_table(status)
+        console.print(table)
+        console.print(f"[dim]{n} path{'' if n == 1 else 's'} staged[/dim]\n")
+    else:
+        console.print("[dim]nothing staged, the tree is clean[/dim]\n")
+
+    msg = m if m != '' else status
+    with _step(2, 3, "git commit"):
+        subprocess.run(["git", "commit", "-m", msg])
+    with _step(3, 3, "git push"):
+        subprocess.run(["git", "push"])
+    _done("gacp", t0)
+
+# %% ../nbs/01_Automate.ipynb #88017a1b-55c1-4833-aeb6-277a7e5b6314
+def status():
+    "Show the working tree state"
+    import subprocess
+
+    def _git(*a, **kw): return subprocess.check_output(["git", *a], **kw).decode('utf-8').strip()
+
+    _banner("status")
+    branch = _git("branch", "--show-current") or "DETACHED"
+    line = f"on [bold]{branch}[/bold]"
+    try:
+        behind, ahead = _git("rev-list", "--left-right", "--count", "@{upstream}...HEAD",
+                             stderr=subprocess.DEVNULL).split()
+        if behind != "0": line += f"  [yellow]behind {behind}[/yellow]"
+        if ahead  != "0": line += f"  [cyan]ahead {ahead}[/cyan]"
+        if behind == ahead == "0": line += "  [dim]in step with upstream[/dim]"
+    except subprocess.CalledProcessError:
+        line += "  [dim]no upstream[/dim]"
+    console.print(line)
+
+    # NOT via _git: `git status -s` pads the code to two columns, so stripping the
+    # output would eat the leading space of the first line and shift its path by one.
+    porcelain = subprocess.check_output(["git", "status", "-s"]).decode('utf-8')
+    if not porcelain:
+        console.print("[green]clean[/green]")
+        return
+    table, n = _status_table(porcelain)
+    console.print(table)
+    console.print(f"[dim]{n} path{'' if n == 1 else 's'} changed[/dim]")
+
+# %% ../nbs/01_Automate.ipynb #8d777a41-0160-47f8-b51c-b14360b62da4
+@call_parse
+def upload(
+    m:str = '', # Commit message
+    p:int = 2, # Increment part
+):
+    "prep then gacp: the everyday command for shipping a notebook change"
+    prep(p)
+    gacp(m)
+
+# %% ../nbs/01_Automate.ipynb #dee37b06-c946-4b40-be0f-056e133751ea
+def release_git():
+    "Bump the MINOR version, then tag and create a GitHub release"
+    import nbdev.release
+    console.rule("[bold]gitrelease")
+    with _step("bump minor version"):
+        nbdev.release.nbdev_bump_version(1)
+    with _step("tag and create the GitHub release"):
+        nbdev.release.release_git()
+
+# %% ../nbs/01_Automate.ipynb #288708c6-194a-4059-9ff0-ae330079c199
+def release_pypi():
+    "Build the sdist and wheel, then upload to PyPI with twine. CI publishes on push, so this is the manual path"
+    import nbdev.release
+    console.rule("[bold]piprelease")
+    with _step("build and upload to PyPI"):
+        nbdev.release.release_pypi()
+
+# %% ../nbs/01_Automate.ipynb #dd798178-9d58-457e-969a-d86a5e8bf875
+def release():
+    "release_git then release_pypi"
+    release_git()
+    release_pypi()
+
+# %% ../nbs/01_Automate.ipynb #c4d2bd52-04c4-43fe-890b-b4cb5da8d206
+def help_output():
+    "Print every console script this package installs, with its help"
+    from importlib.metadata import distribution
+    try:
+        eps = [e for e in distribution("nbdevAuto").entry_points if e.group == "console_scripts"]
+    except Exception:
+        # Running from a source tree with nothing installed: fall back to fastcore.
+        from fastcore.xtras import console_help
+        return console_help('nbdevAuto')
+    _banner("commands")
+    t = Table(box=box.SIMPLE, show_header=False, pad_edge=False, expand=False)
+    t.add_column("command", style="bold cyan", no_wrap=True)
+    t.add_column("does", overflow="fold")
+    for e in sorted(eps, key=lambda e: e.name):
+        try: doc = escape((e.load().__doc__ or "").strip().splitlines()[0])
+        except Exception: doc = "[red]could not load[/red]"
+        t.add_row(e.name, doc)
+    console.print(t)
+    console.print(escape("ghstatus needs the gh extra: pip install 'nbdevAuto[gh]'"), style="dim")

{nbdevauto-0.3.63 → nbdevauto-0.3.64/nbdevAuto.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nbdevAuto
-Version: 0.3.63
+Version: 0.3.64
 Summary: automating nbdev
 Author-email: Benedict Thekkel <bthekkel1@gmail.com>
 License-Expression: Apache-2.0
@@ -23,6 +23,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: graphviz
 Requires-Dist: fastcore
+Requires-Dist: rich
 Provides-Extra: gh
 Requires-Dist: githubkit>=0.12; extra == "gh"
 Dynamic: license-file

{nbdevauto-0.3.63 → nbdevauto-0.3.64}/nbdevAuto.egg-info/requires.txt

@@ -1,5 +1,6 @@
 graphviz
 fastcore
+rich
 
 [gh]
 githubkit>=0.12

{nbdevauto-0.3.63 → nbdevauto-0.3.64}/pyproject.toml

@@ -24,7 +24,7 @@ classifiers = [
     "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: 3.14",
 ]
-dependencies = ['graphviz', 'fastcore']
+dependencies = ['graphviz', 'fastcore', 'rich']
 
 [project.optional-dependencies]
 # An extra, not a dependency: githubkit pulls pydantic + httpx + hishel, which is

nbdevauto-0.3.63/nbdevAuto/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.3.63"

nbdevauto-0.3.63/nbdevAuto/automate.py

@@ -1,97 +0,0 @@
-"""Automate
-
-Docs: https://bthek1.github.io/nbdevAuto/automate.html.md"""
-
-# AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/01_Automate.ipynb.
-
-# %% auto #0
-__all__ = ['prep', 'gacp', 'status', 'upload', 'release_git', 'release_pypi', 'release', 'help_output']
-
-# %% ../nbs/01_Automate.ipynb #6d1499d1-aa55-47d8-92fd-fa056b1fb135
-from fastcore.script import *
-
-@call_parse
-def prep(
-    p:int = 2, # Increment Part
-):
-    "Bump version part `p`, then export, test and clean the notebooks, refreshing _quarto.yml and README"
-
-    import nbdev.test, nbdev.clean, nbdev.quarto, nbdev.release
-    nbdev.release.nbdev_bump_version(p)
-    
-    nbdev.quarto.nbdev_export.__wrapped__()
-    print(f'### nbdev_export finished ###')
-    nbdev.test.nbdev_test.__wrapped__(
-        n_workers = 8,  # Number of workers
-        timing = True,  # Time each notebook to see which are slow
-    )
-    print(f'### nbdev_test finished ###')
-    nbdev.clean.nbdev_clean.__wrapped__()
-    print(f'### nbdev_clean finished ###')
-    nbdev.quarto.refresh_quarto_yml()
-    print(f'### refresh_quarto_yml finished ###')
-    nbdev.quarto.nbdev_readme.__wrapped__(chk_time=True)
-    print(f'### nbdev_readme finished ###')
-
-# %% ../nbs/01_Automate.ipynb #f66ef35f-b7fa-4039-aa07-e9b782d204bb
-@call_parse
-def gacp(
-    m:str = '', # Commit message
-):
-    "git add, commit and push. Without `-m` the commit message is the status output"
-    
-    import subprocess
-    subprocess.run(["git", "add", "."])
-    print(f'### git added ###')
-    status = subprocess.check_output(["git", "status", "-s"]).decode('utf-8')
-    print(f'### git status: "{status}" ###')
-
-    if m != '':
-        subprocess.run(["git", "commit", "-m", f'{m}'])
-        print(f'### git commited "{m}"###')
-    else:
-        subprocess.run(["git", "commit", "-m", f'{status}'])
-        print(f'### git commited status ###')
-    subprocess.run(["git", "push"])
-    print(f'### git pushed ###')
-
-# %% ../nbs/01_Automate.ipynb #88017a1b-55c1-4833-aeb6-277a7e5b6314
-def status():
-    "Show the working tree state"
-    import subprocess
-    subprocess.run(["git", "status"])
-
-# %% ../nbs/01_Automate.ipynb #8d777a41-0160-47f8-b51c-b14360b62da4
-@call_parse
-def upload(    
-    m:str = '', # Commit message
-    p:int = 2, #Increment part
-):
-    "prep then gacp: the everyday command for shipping a notebook change"
-    prep(p)
-    gacp(m)
-
-# %% ../nbs/01_Automate.ipynb #dee37b06-c946-4b40-be0f-056e133751ea
-def release_git():
-    "Bump the MINOR version, then tag and create a GitHub release"
-    import nbdev.release
-    nbdev.release.nbdev_bump_version(1)
-    nbdev.release.release_git()
-
-# %% ../nbs/01_Automate.ipynb #288708c6-194a-4059-9ff0-ae330079c199
-def release_pypi():
-    "Build the sdist and wheel, then upload to PyPI with twine. CI publishes on push, so this is the manual path"
-    import nbdev.release
-    nbdev.release.release_pypi()
-
-# %% ../nbs/01_Automate.ipynb #dd798178-9d58-457e-969a-d86a5e8bf875
-def release():
-    "release_git then release_pypi"
-    release_git()
-    release_pypi()
-
-# %% ../nbs/01_Automate.ipynb #c4d2bd52-04c4-43fe-890b-b4cb5da8d206
-def help_output():
-    "Print every console script this package installs, with its help"
-    from fastcore.xtras import console_help
-    console_help('nbdevAuto')