nbdevAuto 0.3.61__tar.gz → 0.3.64__tar.gz

nbdevauto-0.3.64/PKG-INFO

@@ -0,0 +1,124 @@
+Metadata-Version: 2.4
+Name: nbdevAuto
+Version: 0.3.64
+Summary: automating nbdev
+Author-email: Benedict Thekkel <bthekkel1@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/bthek1/nbdevAuto
+Project-URL: Documentation, https://bthek1.github.io/nbdevAuto
+Project-URL: Issues, https://github.com/bthek1/nbdevAuto/issues
+Keywords: nbdev,jupyter,notebook,python
+Classifier: Natural Language :: English
+Classifier: Intended Audience :: Developers
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.10
+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
+
+
+<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
+
+Unlike most sites in this collection, this one documents an **installable library** rather than a topic. `nbdevAuto` exists because the nbdev release cycle is a fixed sequence of commands typed in the same order every time: export the notebooks, run the tests, clean them, bump the version, commit, push, build the docs. Each step is one nbdev call, and forgetting one produces a confusing failure two steps later.
+
+The library collapses that sequence into single-word shell commands. It is what `just upload` and `just full_upload` invoke under the hood for every submodule in the parent Knowledge repo.
+
+------------------------------------------------------------------------
+
+## Install
+
+``` sh
+pip install nbdevAuto          # the publish-cycle commands and the helpers
+pip install 'nbdevAuto[gh]'    # also installs githubkit, which `ghstatus` needs
+```
+
+Requires Python 3.10 or newer.
+
+## Use
+
+Every exported function is also a console script, so the common case is a bare word in the terminal at the root of an nbdev project:
+
+``` sh
+upload -m "commit message"    # export, test, clean, then add/commit/push
+```
+
+Or import the helpers into a notebook:
+
+``` python
+from nbdevAuto.functions import download_search_images, classify_images
+from nbdevAuto.pdf import PDFreader
+```
+
+------------------------------------------------------------------------
+
+## Contents
+
+| Page | Covers |
+|----|----|
+| [Functions](00_Functions.ipynb) | Dataset and image helpers: reading a list out of a text file, downloading single images or whole search-driven datasets, verifying and resizing what came back, building the folder layout a classifier expects, running a fastai learner over one image, Kaggle competition and dataset shortcuts, and [`graph`](https://bthek1.github.io/nbdevAuto/functions.html#graph), a `graphviz.Digraph` subclass preloaded with a rounded, filled style |
+| [Automate](01_Automate.ipynb) | The command line surface: the prep/commit/push pipeline, the GitHub and PyPI release halves, and the help output that lists them all |
+| [PDF Reader](02_PDF_reader.ipynb) | [`PDFreader`](https://bthek1.github.io/nbdevAuto/pdf_reader.html#pdfreader), a class that converts a PDF through `pdf2image` and renders page ranges inline when you slice it (`pdf[0:5]`) |
+| [GitHub](03_GitHub.ipynb) | [`ghstatus`](https://bthek1.github.io/nbdevAuto/github.html#ghstatus): reading `.gitmodules`, resolving a token, and asking the GitHub API about every submodule at once - CI runs, Pages deploys, Pages builds, remote `main` shas - plus the `--report` and `--audit` views and the exit codes that keep “absent” apart from “cannot ask” |
+
+------------------------------------------------------------------------
+
+## The Command Line Surface
+
+Installing the package puts these on your `PATH`. Most are ordinary functions in [Automate](01_Automate.ipynb), exposed as scripts through `[project.scripts]`; [`ghstatus`](https://bthek1.github.io/nbdevAuto/github.html#ghstatus) comes from [GitHub](03_GitHub.ipynb).
+
+| Command | Does |
+|----|----|
+| [`prep`](https://bthek1.github.io/nbdevAuto/automate.html#prep) | Bump the version, then export, test and clean the notebooks, refreshing `_quarto.yml` and the README |
+| [`gacp`](https://bthek1.github.io/nbdevAuto/automate.html#gacp) | git add, commit, and push. Without `-m` the commit message is the status output |
+| [`status`](https://bthek1.github.io/nbdevAuto/automate.html#status) | Show the working tree state |
+| [`upload`](https://bthek1.github.io/nbdevAuto/automate.html#upload) | [`prep`](https://bthek1.github.io/nbdevAuto/automate.html#prep) then [`gacp`](https://bthek1.github.io/nbdevAuto/automate.html#gacp), the one you actually type |
+| `gitrelease` | Bump the **minor** version, then tag and create a GitHub release |
+| `piprelease` | Build the sdist and wheel, then upload to PyPI with twine |
+| [`release`](https://bthek1.github.io/nbdevAuto/automate.html#release) | `gitrelease` then `piprelease` |
+| [`ghstatus`](https://bthek1.github.io/nbdevAuto/github.html#ghstatus) | Remote status for every submodule of an nbdev superproject, from the GitHub API. `--report` for the sync view, `--audit` to check `.gitmodules` against the repos the account owns, `--json` for machine output |
+| `h` | Print the list of available commands |
+
+Both [`prep`](https://bthek1.github.io/nbdevAuto/automate.html#prep) and [`upload`](https://bthek1.github.io/nbdevAuto/automate.html#upload) take `-p` to choose which version part to increment; it defaults to 2, the patch, so every [`upload`](https://bthek1.github.io/nbdevAuto/automate.html#upload) ships a new version.
+
+`piprelease` is the manual path. Pushing to `main` publishes to PyPI on its own: `publish.yaml` runs after CI passes, and skips quietly when the version is already there.
+
+[`ghstatus`](https://bthek1.github.io/nbdevAuto/github.html#ghstatus) needs the `gh` extra (`pip install 'nbdevAuto[gh]'`), which brings in `githubkit`. It is an extra rather than a dependency because githubkit pulls pydantic, httpx and hishel behind it, which is a lot of weight for anyone who only wants [`upload`](https://bthek1.github.io/nbdevAuto/automate.html#upload). Without it the command exits 3 with an install hint rather than a traceback. It takes its token from `$GITHUB_TOKEN` / `$GH_TOKEN`, then `gh auth token`.
+
+------------------------------------------------------------------------
+
+## Where It Is Used
+
+The parent Knowledge repo’s `justfile` calls [`upload`](https://bthek1.github.io/nbdevAuto/automate.html#upload) once per submodule. `just upload` runs it only where the working tree is dirty, `just full_upload` runs it everywhere. That is the main consumer, so a change to `automate.py` affects the publish path for every site in the collection.
+
+[`ghstatus`](https://bthek1.github.io/nbdevAuto/github.html#ghstatus) is the other half of that loop. [`upload`](https://bthek1.github.io/nbdevAuto/automate.html#upload) pushes to 19 repos and then goes blind: whether each repo’s CI passed and whether its Pages deploy actually landed is invisible from the terminal. `just ci`, `just report` and `just audit` in the parent repo are all thin wrappers around this one command, which answers for the whole fleet in about 1.5 seconds instead of 19 browser tabs.
+
+## Releases
+
+This package publishes itself. A `publish.yaml` workflow runs after CI passes on `main` and uploads to PyPI through Trusted Publishing, so no API token is stored in the repository. It reads `__version__` out of `nbdevAuto/__init__.py` and asks PyPI whether that version already exists: a new version is published, an existing one is skipped without failing the build.
+
+Because [`upload`](https://bthek1.github.io/nbdevAuto/automate.html#upload) bumps the patch version on every push, an ordinary commit made with [`upload`](https://bthek1.github.io/nbdevAuto/automate.html#upload) ships a release. A plain `git commit` leaves the version alone and the workflow skips. `gitrelease`, which bumps the minor version and creates the GitHub release and tag, stays a deliberate manual step.
+
+------------------------------------------------------------------------
+
+## Not Covered Yet
+
+- **No test notebook for the helpers.** `03_GitHub.ipynb` carries unit tests for its pure functions, but the dataset and image helpers are exercised only by being used, so a broken one surfaces in a downstream repo rather than here.
+- **Undeclared dependencies.** `pyproject.toml` declares `graphviz` and `fastcore`, plus `githubkit` behind the `gh` extra. The helpers additionally import `fastai`, `fastbook`, `fastdownload`, `PIL`, `matplotlib`, `tqdm`, `pdf2image` (with poppler behind it), `nbdev` and `kaggle` (which also needs its credentials). All of those are imported lazily inside the function that needs them, so installing the package and running the console scripts still works - only the specific helper you call fails. Install them yourself.
+- **`core.py` is an empty nbdev stub** (a single `foo`) left over from `00_core.ipynb`, which no longer exists.
+- The docstrings are one-liners, so the rendered API pages are thin. The notebooks carry the real explanation.
+
+------------------------------------------------------------------------

nbdevauto-0.3.64/README.md

@@ -0,0 +1,94 @@
+# nbdevAuto
+
+
+<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
+
+Unlike most sites in this collection, this one documents an **installable library** rather than a topic. `nbdevAuto` exists because the nbdev release cycle is a fixed sequence of commands typed in the same order every time: export the notebooks, run the tests, clean them, bump the version, commit, push, build the docs. Each step is one nbdev call, and forgetting one produces a confusing failure two steps later.
+
+The library collapses that sequence into single-word shell commands. It is what `just upload` and `just full_upload` invoke under the hood for every submodule in the parent Knowledge repo.
+
+------------------------------------------------------------------------
+
+## Install
+
+``` sh
+pip install nbdevAuto          # the publish-cycle commands and the helpers
+pip install 'nbdevAuto[gh]'    # also installs githubkit, which `ghstatus` needs
+```
+
+Requires Python 3.10 or newer.
+
+## Use
+
+Every exported function is also a console script, so the common case is a bare word in the terminal at the root of an nbdev project:
+
+``` sh
+upload -m "commit message"    # export, test, clean, then add/commit/push
+```
+
+Or import the helpers into a notebook:
+
+``` python
+from nbdevAuto.functions import download_search_images, classify_images
+from nbdevAuto.pdf import PDFreader
+```
+
+------------------------------------------------------------------------
+
+## Contents
+
+| Page | Covers |
+|----|----|
+| [Functions](00_Functions.ipynb) | Dataset and image helpers: reading a list out of a text file, downloading single images or whole search-driven datasets, verifying and resizing what came back, building the folder layout a classifier expects, running a fastai learner over one image, Kaggle competition and dataset shortcuts, and [`graph`](https://bthek1.github.io/nbdevAuto/functions.html#graph), a `graphviz.Digraph` subclass preloaded with a rounded, filled style |
+| [Automate](01_Automate.ipynb) | The command line surface: the prep/commit/push pipeline, the GitHub and PyPI release halves, and the help output that lists them all |
+| [PDF Reader](02_PDF_reader.ipynb) | [`PDFreader`](https://bthek1.github.io/nbdevAuto/pdf_reader.html#pdfreader), a class that converts a PDF through `pdf2image` and renders page ranges inline when you slice it (`pdf[0:5]`) |
+| [GitHub](03_GitHub.ipynb) | [`ghstatus`](https://bthek1.github.io/nbdevAuto/github.html#ghstatus): reading `.gitmodules`, resolving a token, and asking the GitHub API about every submodule at once - CI runs, Pages deploys, Pages builds, remote `main` shas - plus the `--report` and `--audit` views and the exit codes that keep “absent” apart from “cannot ask” |
+
+------------------------------------------------------------------------
+
+## The Command Line Surface
+
+Installing the package puts these on your `PATH`. Most are ordinary functions in [Automate](01_Automate.ipynb), exposed as scripts through `[project.scripts]`; [`ghstatus`](https://bthek1.github.io/nbdevAuto/github.html#ghstatus) comes from [GitHub](03_GitHub.ipynb).
+
+| Command | Does |
+|----|----|
+| [`prep`](https://bthek1.github.io/nbdevAuto/automate.html#prep) | Bump the version, then export, test and clean the notebooks, refreshing `_quarto.yml` and the README |
+| [`gacp`](https://bthek1.github.io/nbdevAuto/automate.html#gacp) | git add, commit, and push. Without `-m` the commit message is the status output |
+| [`status`](https://bthek1.github.io/nbdevAuto/automate.html#status) | Show the working tree state |
+| [`upload`](https://bthek1.github.io/nbdevAuto/automate.html#upload) | [`prep`](https://bthek1.github.io/nbdevAuto/automate.html#prep) then [`gacp`](https://bthek1.github.io/nbdevAuto/automate.html#gacp), the one you actually type |
+| `gitrelease` | Bump the **minor** version, then tag and create a GitHub release |
+| `piprelease` | Build the sdist and wheel, then upload to PyPI with twine |
+| [`release`](https://bthek1.github.io/nbdevAuto/automate.html#release) | `gitrelease` then `piprelease` |
+| [`ghstatus`](https://bthek1.github.io/nbdevAuto/github.html#ghstatus) | Remote status for every submodule of an nbdev superproject, from the GitHub API. `--report` for the sync view, `--audit` to check `.gitmodules` against the repos the account owns, `--json` for machine output |
+| `h` | Print the list of available commands |
+
+Both [`prep`](https://bthek1.github.io/nbdevAuto/automate.html#prep) and [`upload`](https://bthek1.github.io/nbdevAuto/automate.html#upload) take `-p` to choose which version part to increment; it defaults to 2, the patch, so every [`upload`](https://bthek1.github.io/nbdevAuto/automate.html#upload) ships a new version.
+
+`piprelease` is the manual path. Pushing to `main` publishes to PyPI on its own: `publish.yaml` runs after CI passes, and skips quietly when the version is already there.
+
+[`ghstatus`](https://bthek1.github.io/nbdevAuto/github.html#ghstatus) needs the `gh` extra (`pip install 'nbdevAuto[gh]'`), which brings in `githubkit`. It is an extra rather than a dependency because githubkit pulls pydantic, httpx and hishel behind it, which is a lot of weight for anyone who only wants [`upload`](https://bthek1.github.io/nbdevAuto/automate.html#upload). Without it the command exits 3 with an install hint rather than a traceback. It takes its token from `$GITHUB_TOKEN` / `$GH_TOKEN`, then `gh auth token`.
+
+------------------------------------------------------------------------
+
+## Where It Is Used
+
+The parent Knowledge repo’s `justfile` calls [`upload`](https://bthek1.github.io/nbdevAuto/automate.html#upload) once per submodule. `just upload` runs it only where the working tree is dirty, `just full_upload` runs it everywhere. That is the main consumer, so a change to `automate.py` affects the publish path for every site in the collection.
+
+[`ghstatus`](https://bthek1.github.io/nbdevAuto/github.html#ghstatus) is the other half of that loop. [`upload`](https://bthek1.github.io/nbdevAuto/automate.html#upload) pushes to 19 repos and then goes blind: whether each repo’s CI passed and whether its Pages deploy actually landed is invisible from the terminal. `just ci`, `just report` and `just audit` in the parent repo are all thin wrappers around this one command, which answers for the whole fleet in about 1.5 seconds instead of 19 browser tabs.
+
+## Releases
+
+This package publishes itself. A `publish.yaml` workflow runs after CI passes on `main` and uploads to PyPI through Trusted Publishing, so no API token is stored in the repository. It reads `__version__` out of `nbdevAuto/__init__.py` and asks PyPI whether that version already exists: a new version is published, an existing one is skipped without failing the build.
+
+Because [`upload`](https://bthek1.github.io/nbdevAuto/automate.html#upload) bumps the patch version on every push, an ordinary commit made with [`upload`](https://bthek1.github.io/nbdevAuto/automate.html#upload) ships a release. A plain `git commit` leaves the version alone and the workflow skips. `gitrelease`, which bumps the minor version and creates the GitHub release and tag, stays a deliberate manual step.
+
+------------------------------------------------------------------------
+
+## Not Covered Yet
+
+- **No test notebook for the helpers.** `03_GitHub.ipynb` carries unit tests for its pure functions, but the dataset and image helpers are exercised only by being used, so a broken one surfaces in a downstream repo rather than here.
+- **Undeclared dependencies.** `pyproject.toml` declares `graphviz` and `fastcore`, plus `githubkit` behind the `gh` extra. The helpers additionally import `fastai`, `fastbook`, `fastdownload`, `PIL`, `matplotlib`, `tqdm`, `pdf2image` (with poppler behind it), `nbdev` and `kaggle` (which also needs its credentials). All of those are imported lazily inside the function that needs them, so installing the package and running the console scripts still works - only the specific helper you call fails. Install them yourself.
+- **`core.py` is an empty nbdev stub** (a single `foo`) left over from `00_core.ipynb`, which no longer exists.
+- The docstrings are one-liners, so the rendered API pages are thin. The notebooks carry the real explanation.
+
+------------------------------------------------------------------------

nbdevauto-0.3.64/nbdevAuto/__init__.py

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

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

@@ -5,18 +5,18 @@ 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.create_env': ('automate.html#create_env', 'nbdevAuto/automate.py'),
-                                    'nbdevAuto.automate.everything': ('automate.html#everything', '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.hello': ('automate.html#hello', '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.reinstall': ('automate.html#reinstall', 'nbdevAuto/automate.py'),
                                     'nbdevAuto.automate.release': ('automate.html#release', 'nbdevAuto/automate.py'),
                                     'nbdevAuto.automate.release_git': ('automate.html#release_git', 'nbdevAuto/automate.py'),
                                     'nbdevAuto.automate.release_pypi': ('automate.html#release_pypi', 'nbdevAuto/automate.py'),
                                     'nbdevAuto.automate.status': ('automate.html#status', 'nbdevAuto/automate.py'),
-                                    'nbdevAuto.automate.update': ('automate.html#update', 'nbdevAuto/automate.py'),
                                     'nbdevAuto.automate.upload': ('automate.html#upload', 'nbdevAuto/automate.py')},
             'nbdevAuto.functions': { 'nbdevAuto.functions.classify_images': ('functions.html#classify_images', 'nbdevAuto/functions.py'),
                                      'nbdevAuto.functions.create_data_folder': ( 'functions.html#create_data_folder',
@@ -49,6 +49,7 @@ d = { 'settings': { 'branch': 'main',
                                   'nbdevAuto.github.ahead_behind': ('github.html#ahead_behind', 'nbdevAuto/github.py'),
                                   'nbdevAuto.github.api_error': ('github.html#api_error', 'nbdevAuto/github.py'),
                                   'nbdevAuto.github.audit_result': ('github.html#audit_result', 'nbdevAuto/github.py'),
+                                  'nbdevAuto.github.client': ('github.html#client', 'nbdevAuto/github.py'),
                                   'nbdevAuto.github.failures': ('github.html#failures', 'nbdevAuto/github.py'),
                                   'nbdevAuto.github.find_root': ('github.html#find_root', 'nbdevAuto/github.py'),
                                   'nbdevAuto.github.format_audit': ('github.html#format_audit', 'nbdevAuto/github.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.61 → nbdevauto-0.3.64}/nbdevAuto/github.py

@@ -6,9 +6,9 @@ Docs: https://bthek1.github.io/nbdevAuto/github.html.md"""
 
 # %% auto #0
 __all__ = ['Submodule', 'CI_WORKFLOWS', 'PAGES_WORKFLOWS', 'FAILED', 'RUNNING', 'BOLD', 'RED', 'YELLOW', 'CYAN', 'DIM', 'OFF',
-           'find_root', 'parse_gitmodules', 'resolve_token', 'local_sha', 'api_error', 'repo_status', 'gather_status',
-           'format_table', 'failures', 'has_failure', 'git', 'local_state', 'ahead_behind', 'add_local',
-           'format_report', 'stale_sections', 'owned_repos', 'self_repo', 'audit_result', 'gather_audit',
+           'find_root', 'parse_gitmodules', 'resolve_token', 'local_sha', 'api_error', 'repo_status', 'client',
+           'gather_status', 'format_table', 'failures', 'has_failure', 'git', 'local_state', 'ahead_behind',
+           'add_local', 'format_report', 'stale_sections', 'owned_repos', 'self_repo', 'audit_result', 'gather_audit',
            'format_audit', 'ghstatus']
 
 # %% ../nbs/03_GitHub.ipynb #519f31cd-5e6f-4ff9-9137-0293e57c0929
@@ -139,15 +139,33 @@ async def repo_status(gh, sub, root=None):
             "ci": ci, "deploy": deploy, "built": built, "remote": remote,
             "local": local_sha(Path(root or find_root())/sub.path)}
 
-async def gather_status(subs, token=None, root=None):
-    "Every row, concurrently, through one client and one connection pool"
+def client(token=None):
+    "One githubkit client, with githubkit's response cache turned off"
     try:
         from githubkit import GitHub
     except ImportError:
         raise ImportError("githubkit is not installed: pip install 'nbdevAuto[gh]'") from None
-    async with GitHub(token or resolve_token()) as gh:
+    # githubkit defaults to http_cache=True. Its default MemCacheStrategy sounds
+    # like a dict but is not: githubkit's AsyncMemoryStorage subclasses hishel's
+    # AsyncSqliteStorage over a ":memory:" database, so every cached response is a
+    # transaction on one shared anysqlite connection. This tool issues ~76 requests
+    # concurrently through a single client, and those transactions collide: runs
+    # die intermittently on "cannot start a transaction within a transaction" or
+    # "bad parameter or other API misuse" and exit 3, which reads as "cannot ask
+    # GitHub" on a perfectly healthy fleet. Observed about twice in 40 runs.
+    #
+    # Caching is the wrong default for this question anyway - the whole point is to
+    # see whether the thing just pushed has built yet - and 76 calls against a
+    # 5000/hour budget do not need it. Turning it off removes the shared connection
+    # from the concurrent path entirely.
+    return GitHub(token or resolve_token(), http_cache=False)
+
+async def gather_status(subs, token=None, root=None):
+    "Every row, concurrently, through one client and one connection pool"
+    async with client(token) as gh:
         return await asyncio.gather(*[repo_status(gh, s, root) for s in subs])
 
+
 # %% ../nbs/03_GitHub.ipynb #d4d8fd92-b4a2-4479-bd76-df3cc7fc9f77
 FAILED  = {"failure", "timed_out", "cancelled", "action_required", "startup_failure"}
 RUNNING = {"in_progress", "queued", "requested", "waiting", "pending"}
@@ -287,15 +305,12 @@ def audit_result(subs, login, every, active, stale, exclude=()):
 
 async def gather_audit(subs, root, token=None):
     "The audit, one client, one pass over the account's repos"
-    try:
-        from githubkit import GitHub
-    except ImportError:
-        raise ImportError("githubkit is not installed: pip install 'nbdevAuto[gh]'") from None
-    async with GitHub(token or resolve_token()) as gh:
+    async with client(token) as gh:
         login, every, active = await owned_repos(gh)
     return audit_result(subs, login, every, active, stale_sections(root),
                         exclude=[self_repo(root)])
 
+
 # %% ../nbs/03_GitHub.ipynb #5e8ec6fc-9878-422c-b4bd-a0ce64dd8234
 def _wrap(items, width=92):
     "Comma-joined `items`, wrapped to `width` columns"

nbdevauto-0.3.64/nbdevAuto.egg-info/PKG-INFO

@@ -0,0 +1,124 @@
+Metadata-Version: 2.4
+Name: nbdevAuto
+Version: 0.3.64
+Summary: automating nbdev
+Author-email: Benedict Thekkel <bthekkel1@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/bthek1/nbdevAuto
+Project-URL: Documentation, https://bthek1.github.io/nbdevAuto
+Project-URL: Issues, https://github.com/bthek1/nbdevAuto/issues
+Keywords: nbdev,jupyter,notebook,python
+Classifier: Natural Language :: English
+Classifier: Intended Audience :: Developers
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.10
+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
+
+
+<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
+
+Unlike most sites in this collection, this one documents an **installable library** rather than a topic. `nbdevAuto` exists because the nbdev release cycle is a fixed sequence of commands typed in the same order every time: export the notebooks, run the tests, clean them, bump the version, commit, push, build the docs. Each step is one nbdev call, and forgetting one produces a confusing failure two steps later.
+
+The library collapses that sequence into single-word shell commands. It is what `just upload` and `just full_upload` invoke under the hood for every submodule in the parent Knowledge repo.
+
+------------------------------------------------------------------------
+
+## Install
+
+``` sh
+pip install nbdevAuto          # the publish-cycle commands and the helpers
+pip install 'nbdevAuto[gh]'    # also installs githubkit, which `ghstatus` needs
+```
+
+Requires Python 3.10 or newer.
+
+## Use
+
+Every exported function is also a console script, so the common case is a bare word in the terminal at the root of an nbdev project:
+
+``` sh
+upload -m "commit message"    # export, test, clean, then add/commit/push
+```
+
+Or import the helpers into a notebook:
+
+``` python
+from nbdevAuto.functions import download_search_images, classify_images
+from nbdevAuto.pdf import PDFreader
+```
+
+------------------------------------------------------------------------
+
+## Contents
+
+| Page | Covers |
+|----|----|
+| [Functions](00_Functions.ipynb) | Dataset and image helpers: reading a list out of a text file, downloading single images or whole search-driven datasets, verifying and resizing what came back, building the folder layout a classifier expects, running a fastai learner over one image, Kaggle competition and dataset shortcuts, and [`graph`](https://bthek1.github.io/nbdevAuto/functions.html#graph), a `graphviz.Digraph` subclass preloaded with a rounded, filled style |
+| [Automate](01_Automate.ipynb) | The command line surface: the prep/commit/push pipeline, the GitHub and PyPI release halves, and the help output that lists them all |
+| [PDF Reader](02_PDF_reader.ipynb) | [`PDFreader`](https://bthek1.github.io/nbdevAuto/pdf_reader.html#pdfreader), a class that converts a PDF through `pdf2image` and renders page ranges inline when you slice it (`pdf[0:5]`) |
+| [GitHub](03_GitHub.ipynb) | [`ghstatus`](https://bthek1.github.io/nbdevAuto/github.html#ghstatus): reading `.gitmodules`, resolving a token, and asking the GitHub API about every submodule at once - CI runs, Pages deploys, Pages builds, remote `main` shas - plus the `--report` and `--audit` views and the exit codes that keep “absent” apart from “cannot ask” |
+
+------------------------------------------------------------------------
+
+## The Command Line Surface
+
+Installing the package puts these on your `PATH`. Most are ordinary functions in [Automate](01_Automate.ipynb), exposed as scripts through `[project.scripts]`; [`ghstatus`](https://bthek1.github.io/nbdevAuto/github.html#ghstatus) comes from [GitHub](03_GitHub.ipynb).
+
+| Command | Does |
+|----|----|
+| [`prep`](https://bthek1.github.io/nbdevAuto/automate.html#prep) | Bump the version, then export, test and clean the notebooks, refreshing `_quarto.yml` and the README |
+| [`gacp`](https://bthek1.github.io/nbdevAuto/automate.html#gacp) | git add, commit, and push. Without `-m` the commit message is the status output |
+| [`status`](https://bthek1.github.io/nbdevAuto/automate.html#status) | Show the working tree state |
+| [`upload`](https://bthek1.github.io/nbdevAuto/automate.html#upload) | [`prep`](https://bthek1.github.io/nbdevAuto/automate.html#prep) then [`gacp`](https://bthek1.github.io/nbdevAuto/automate.html#gacp), the one you actually type |
+| `gitrelease` | Bump the **minor** version, then tag and create a GitHub release |
+| `piprelease` | Build the sdist and wheel, then upload to PyPI with twine |
+| [`release`](https://bthek1.github.io/nbdevAuto/automate.html#release) | `gitrelease` then `piprelease` |
+| [`ghstatus`](https://bthek1.github.io/nbdevAuto/github.html#ghstatus) | Remote status for every submodule of an nbdev superproject, from the GitHub API. `--report` for the sync view, `--audit` to check `.gitmodules` against the repos the account owns, `--json` for machine output |
+| `h` | Print the list of available commands |
+
+Both [`prep`](https://bthek1.github.io/nbdevAuto/automate.html#prep) and [`upload`](https://bthek1.github.io/nbdevAuto/automate.html#upload) take `-p` to choose which version part to increment; it defaults to 2, the patch, so every [`upload`](https://bthek1.github.io/nbdevAuto/automate.html#upload) ships a new version.
+
+`piprelease` is the manual path. Pushing to `main` publishes to PyPI on its own: `publish.yaml` runs after CI passes, and skips quietly when the version is already there.
+
+[`ghstatus`](https://bthek1.github.io/nbdevAuto/github.html#ghstatus) needs the `gh` extra (`pip install 'nbdevAuto[gh]'`), which brings in `githubkit`. It is an extra rather than a dependency because githubkit pulls pydantic, httpx and hishel behind it, which is a lot of weight for anyone who only wants [`upload`](https://bthek1.github.io/nbdevAuto/automate.html#upload). Without it the command exits 3 with an install hint rather than a traceback. It takes its token from `$GITHUB_TOKEN` / `$GH_TOKEN`, then `gh auth token`.
+
+------------------------------------------------------------------------
+
+## Where It Is Used
+
+The parent Knowledge repo’s `justfile` calls [`upload`](https://bthek1.github.io/nbdevAuto/automate.html#upload) once per submodule. `just upload` runs it only where the working tree is dirty, `just full_upload` runs it everywhere. That is the main consumer, so a change to `automate.py` affects the publish path for every site in the collection.
+
+[`ghstatus`](https://bthek1.github.io/nbdevAuto/github.html#ghstatus) is the other half of that loop. [`upload`](https://bthek1.github.io/nbdevAuto/automate.html#upload) pushes to 19 repos and then goes blind: whether each repo’s CI passed and whether its Pages deploy actually landed is invisible from the terminal. `just ci`, `just report` and `just audit` in the parent repo are all thin wrappers around this one command, which answers for the whole fleet in about 1.5 seconds instead of 19 browser tabs.
+
+## Releases
+
+This package publishes itself. A `publish.yaml` workflow runs after CI passes on `main` and uploads to PyPI through Trusted Publishing, so no API token is stored in the repository. It reads `__version__` out of `nbdevAuto/__init__.py` and asks PyPI whether that version already exists: a new version is published, an existing one is skipped without failing the build.
+
+Because [`upload`](https://bthek1.github.io/nbdevAuto/automate.html#upload) bumps the patch version on every push, an ordinary commit made with [`upload`](https://bthek1.github.io/nbdevAuto/automate.html#upload) ships a release. A plain `git commit` leaves the version alone and the workflow skips. `gitrelease`, which bumps the minor version and creates the GitHub release and tag, stays a deliberate manual step.
+
+------------------------------------------------------------------------
+
+## Not Covered Yet
+
+- **No test notebook for the helpers.** `03_GitHub.ipynb` carries unit tests for its pure functions, but the dataset and image helpers are exercised only by being used, so a broken one surfaces in a downstream repo rather than here.
+- **Undeclared dependencies.** `pyproject.toml` declares `graphviz` and `fastcore`, plus `githubkit` behind the `gh` extra. The helpers additionally import `fastai`, `fastbook`, `fastdownload`, `PIL`, `matplotlib`, `tqdm`, `pdf2image` (with poppler behind it), `nbdev` and `kaggle` (which also needs its credentials). All of those are imported lazily inside the function that needs them, so installing the package and running the console scripts still works - only the specific helper you call fails. Install them yourself.
+- **`core.py` is an empty nbdev stub** (a single `foo`) left over from `00_core.ipynb`, which no longer exists.
+- The docstrings are one-liners, so the rendered API pages are thin. The notebooks carry the real explanation.
+
+------------------------------------------------------------------------

{nbdevauto-0.3.61 → nbdevauto-0.3.64}/nbdevAuto.egg-info/entry_points.txt

@@ -1,17 +1,12 @@
 [console_scripts]
-create_env = nbdevAuto.automate:create_env
-everything = nbdevAuto.automate:everything
 gacp = nbdevAuto.automate:gacp
 ghstatus = nbdevAuto.github:ghstatus
 gitrelease = nbdevAuto.automate:release_git
 h = nbdevAuto.automate:help_output
-hello = nbdevAuto.automate:hello
 piprelease = nbdevAuto.automate:release_pypi
 prep = nbdevAuto.automate:prep
-reinstall = nbdevAuto.automate:reinstall
 release = nbdevAuto.automate:release
 status = nbdevAuto.automate:status
-update = nbdevAuto.automate:update
 upload = nbdevAuto.automate:upload
 
 [nbdev]

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

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

{nbdevauto-0.3.61 → 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
@@ -46,15 +46,10 @@ prep = "nbdevAuto.automate:prep"
 gacp = "nbdevAuto.automate:gacp"
 status = "nbdevAuto.automate:status"
 upload = "nbdevAuto.automate:upload"
-reinstall = "nbdevAuto.automate:reinstall"
-update = "nbdevAuto.automate:update"
 gitrelease = "nbdevAuto.automate:release_git"
 piprelease = "nbdevAuto.automate:release_pypi"
 release = "nbdevAuto.automate:release"
 h = "nbdevAuto.automate:help_output"
-everything = "nbdevAuto.automate:everything"
-create_env = "nbdevAuto.automate:create_env"
-hello = "nbdevAuto.automate:hello"
 ghstatus = "nbdevAuto.github:ghstatus"
 
 [tool.setuptools.dynamic]

nbdevauto-0.3.61/PKG-INFO

@@ -1,134 +0,0 @@
-Metadata-Version: 2.4
-Name: nbdevAuto
-Version: 0.3.61
-Summary: automating nbdev
-Author-email: Benedict Thekkel <bthekkel1@gmail.com>
-License-Expression: Apache-2.0
-Project-URL: Repository, https://github.com/bthek1/nbdevAuto
-Project-URL: Documentation, https://bthek1.github.io/nbdevAuto
-Project-URL: Issues, https://github.com/bthek1/nbdevAuto/issues
-Keywords: nbdev,jupyter,notebook,python
-Classifier: Natural Language :: English
-Classifier: Intended Audience :: Developers
-Classifier: Development Status :: 3 - Alpha
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: graphviz
-Requires-Dist: fastcore
-Provides-Extra: gh
-Requires-Dist: githubkit>=0.12; extra == "gh"
-Dynamic: license-file
-
-# nbdevAuto
-
-
-<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
-
-Unlike most sites in this collection, this one documents an
-**installable library** rather than a topic. `nbdevAuto` exists because
-the nbdev release cycle is a fixed sequence of commands typed in the
-same order every time: export the notebooks, run the tests, clean them,
-bump the version, commit, push, build the docs. Each step is one nbdev
-call, and forgetting one produces a confusing failure two steps later.
-
-The library collapses that sequence into single-word shell commands. It
-is what `just upload` and `just full_upload` invoke under the hood for
-every submodule in the parent Knowledge repo.
-
-------------------------------------------------------------------------
-
-## Install
-
-``` sh
-pip install nbdevAuto
-```
-
-## Use
-
-Every exported function is also a console script, so the common case is
-a bare word in the terminal at the root of an nbdev project:
-
-``` sh
-upload -m "commit message"    # export, test, clean, then add/commit/push
-```
-
-Or import the helpers into a notebook:
-
-``` python
-from nbdevAuto.functions import download_search_images, classify_images
-from nbdevAuto.pdf import PDFreader
-```
-
-------------------------------------------------------------------------
-
-## Contents
-
-| Page | Covers |
-|----|----|
-| [Functions](00_Functions.ipynb) | Dataset and image helpers: reading a list out of a text file, downloading single images or whole search-driven datasets, verifying and resizing what came back, building the folder layout a classifier expects, running a fastai learner over one image, Kaggle competition and dataset shortcuts, and [`graph`](https://bthek1.github.io/nbdevAuto/functions.html#graph), a `graphviz.Digraph` subclass preloaded with a rounded, filled style |
-| [Automate](01_Automate.ipynb) | The command line surface: the prep/commit/push pipeline, GitHub and PyPI releases, reinstall and update, conda environment creation, and the help output that lists them all |
-| [PDF Reader](02_PDF_reader.ipynb) | [`PDFreader`](https://bthek1.github.io/nbdevAuto/pdf_reader.html#pdfreader), a class that converts a PDF through `pdf2image` and renders page ranges inline when you slice it (`pdf[0:5]`) |
-
-------------------------------------------------------------------------
-
-## The Command Line Surface
-
-Installing the package puts these on your `PATH`. They are ordinary
-functions in [Automate](01_Automate.ipynb), exposed as scripts through
-`[project.scripts]`.
-
-| Command | Does |
-|----|----|
-| [`prep`](https://bthek1.github.io/nbdevAuto/automate.html#prep) | Export, test, and clean the notebooks, rendering the README if it needs it |
-| [`gacp`](https://bthek1.github.io/nbdevAuto/automate.html#gacp) | git add, commit, and push, with `-m` for the message |
-| [`status`](https://bthek1.github.io/nbdevAuto/automate.html#status) | Show the working tree state |
-| [`upload`](https://bthek1.github.io/nbdevAuto/automate.html#upload) | [`prep`](https://bthek1.github.io/nbdevAuto/automate.html#prep) then [`gacp`](https://bthek1.github.io/nbdevAuto/automate.html#gacp), the one you actually type |
-| [`release`](https://bthek1.github.io/nbdevAuto/automate.html#release) | Bump the version, then release to both GitHub and PyPI |
-| `gitrelease` / `piprelease` | The two halves of [`release`](https://bthek1.github.io/nbdevAuto/automate.html#release), separately |
-| [`reinstall`](https://bthek1.github.io/nbdevAuto/automate.html#reinstall) / [`update`](https://bthek1.github.io/nbdevAuto/automate.html#update) | Reinstall or update the package locally |
-| [`everything`](https://bthek1.github.io/nbdevAuto/automate.html#everything) | [`upload`](https://bthek1.github.io/nbdevAuto/automate.html#upload), [`update`](https://bthek1.github.io/nbdevAuto/automate.html#update), [`release`](https://bthek1.github.io/nbdevAuto/automate.html#release), [`reinstall`](https://bthek1.github.io/nbdevAuto/automate.html#reinstall), in that order |
-| [`create_env`](https://bthek1.github.io/nbdevAuto/automate.html#create_env) | Create a conda environment for AI work, named `fast` by default |
-| `h` | Print the list of available commands |
-
-Both [`prep`](https://bthek1.github.io/nbdevAuto/automate.html#prep) and
-[`upload`](https://bthek1.github.io/nbdevAuto/automate.html#upload) take
-`-p` to choose which version part to increment.
-
-------------------------------------------------------------------------
-
-## Where It Is Used
-
-The parent Knowledge repo’s `justfile` calls
-[`upload`](https://bthek1.github.io/nbdevAuto/automate.html#upload) once
-per submodule. `just upload` runs it only where the working tree is
-dirty, `just full_upload` runs it everywhere. That is the main consumer,
-so a change to `automate.py` affects the publish path for every site in
-the collection.
-
-------------------------------------------------------------------------
-
-## Not Covered Yet
-
-- **No test notebook.** The functions are exercised only by being used,
-  so a broken helper surfaces in a downstream repo rather than here.
-- **Undeclared dependencies.** `pyproject.toml` lists only `graphviz`,
-  but the image helpers import `fastai`, the Kaggle shortcuts need the
-  Kaggle CLI and its credentials, and
-  [`PDFreader`](https://bthek1.github.io/nbdevAuto/pdf_reader.html#pdfreader)
-  needs `pdf2image` with poppler behind it, plus matplotlib. Install
-  those yourself.
-- **`core.py` is an empty nbdev stub** (a single
-  [`foo`](https://bthek1.github.io/nbdevAuto/core.html#foo)), with no
-  notebook behind it.
-- The docstrings are one-liners, so the rendered API pages are thin. The
-  notebooks carry the real explanation.
-
-------------------------------------------------------------------------

nbdevauto-0.3.61/README.md

@@ -1,105 +0,0 @@
-# nbdevAuto
-
-
-<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
-
-Unlike most sites in this collection, this one documents an
-**installable library** rather than a topic. `nbdevAuto` exists because
-the nbdev release cycle is a fixed sequence of commands typed in the
-same order every time: export the notebooks, run the tests, clean them,
-bump the version, commit, push, build the docs. Each step is one nbdev
-call, and forgetting one produces a confusing failure two steps later.
-
-The library collapses that sequence into single-word shell commands. It
-is what `just upload` and `just full_upload` invoke under the hood for
-every submodule in the parent Knowledge repo.
-
-------------------------------------------------------------------------
-
-## Install
-
-``` sh
-pip install nbdevAuto
-```
-
-## Use
-
-Every exported function is also a console script, so the common case is
-a bare word in the terminal at the root of an nbdev project:
-
-``` sh
-upload -m "commit message"    # export, test, clean, then add/commit/push
-```
-
-Or import the helpers into a notebook:
-
-``` python
-from nbdevAuto.functions import download_search_images, classify_images
-from nbdevAuto.pdf import PDFreader
-```
-
-------------------------------------------------------------------------
-
-## Contents
-
-| Page | Covers |
-|----|----|
-| [Functions](00_Functions.ipynb) | Dataset and image helpers: reading a list out of a text file, downloading single images or whole search-driven datasets, verifying and resizing what came back, building the folder layout a classifier expects, running a fastai learner over one image, Kaggle competition and dataset shortcuts, and [`graph`](https://bthek1.github.io/nbdevAuto/functions.html#graph), a `graphviz.Digraph` subclass preloaded with a rounded, filled style |
-| [Automate](01_Automate.ipynb) | The command line surface: the prep/commit/push pipeline, GitHub and PyPI releases, reinstall and update, conda environment creation, and the help output that lists them all |
-| [PDF Reader](02_PDF_reader.ipynb) | [`PDFreader`](https://bthek1.github.io/nbdevAuto/pdf_reader.html#pdfreader), a class that converts a PDF through `pdf2image` and renders page ranges inline when you slice it (`pdf[0:5]`) |
-
-------------------------------------------------------------------------
-
-## The Command Line Surface
-
-Installing the package puts these on your `PATH`. They are ordinary
-functions in [Automate](01_Automate.ipynb), exposed as scripts through
-`[project.scripts]`.
-
-| Command | Does |
-|----|----|
-| [`prep`](https://bthek1.github.io/nbdevAuto/automate.html#prep) | Export, test, and clean the notebooks, rendering the README if it needs it |
-| [`gacp`](https://bthek1.github.io/nbdevAuto/automate.html#gacp) | git add, commit, and push, with `-m` for the message |
-| [`status`](https://bthek1.github.io/nbdevAuto/automate.html#status) | Show the working tree state |
-| [`upload`](https://bthek1.github.io/nbdevAuto/automate.html#upload) | [`prep`](https://bthek1.github.io/nbdevAuto/automate.html#prep) then [`gacp`](https://bthek1.github.io/nbdevAuto/automate.html#gacp), the one you actually type |
-| [`release`](https://bthek1.github.io/nbdevAuto/automate.html#release) | Bump the version, then release to both GitHub and PyPI |
-| `gitrelease` / `piprelease` | The two halves of [`release`](https://bthek1.github.io/nbdevAuto/automate.html#release), separately |
-| [`reinstall`](https://bthek1.github.io/nbdevAuto/automate.html#reinstall) / [`update`](https://bthek1.github.io/nbdevAuto/automate.html#update) | Reinstall or update the package locally |
-| [`everything`](https://bthek1.github.io/nbdevAuto/automate.html#everything) | [`upload`](https://bthek1.github.io/nbdevAuto/automate.html#upload), [`update`](https://bthek1.github.io/nbdevAuto/automate.html#update), [`release`](https://bthek1.github.io/nbdevAuto/automate.html#release), [`reinstall`](https://bthek1.github.io/nbdevAuto/automate.html#reinstall), in that order |
-| [`create_env`](https://bthek1.github.io/nbdevAuto/automate.html#create_env) | Create a conda environment for AI work, named `fast` by default |
-| `h` | Print the list of available commands |
-
-Both [`prep`](https://bthek1.github.io/nbdevAuto/automate.html#prep) and
-[`upload`](https://bthek1.github.io/nbdevAuto/automate.html#upload) take
-`-p` to choose which version part to increment.
-
-------------------------------------------------------------------------
-
-## Where It Is Used
-
-The parent Knowledge repo’s `justfile` calls
-[`upload`](https://bthek1.github.io/nbdevAuto/automate.html#upload) once
-per submodule. `just upload` runs it only where the working tree is
-dirty, `just full_upload` runs it everywhere. That is the main consumer,
-so a change to `automate.py` affects the publish path for every site in
-the collection.
-
-------------------------------------------------------------------------
-
-## Not Covered Yet
-
-- **No test notebook.** The functions are exercised only by being used,
-  so a broken helper surfaces in a downstream repo rather than here.
-- **Undeclared dependencies.** `pyproject.toml` lists only `graphviz`,
-  but the image helpers import `fastai`, the Kaggle shortcuts need the
-  Kaggle CLI and its credentials, and
-  [`PDFreader`](https://bthek1.github.io/nbdevAuto/pdf_reader.html#pdfreader)
-  needs `pdf2image` with poppler behind it, plus matplotlib. Install
-  those yourself.
-- **`core.py` is an empty nbdev stub** (a single
-  [`foo`](https://bthek1.github.io/nbdevAuto/core.html#foo)), with no
-  notebook behind it.
-- The docstrings are one-liners, so the rendered API pages are thin. The
-  notebooks carry the real explanation.
-
-------------------------------------------------------------------------

nbdevauto-0.3.61/nbdevAuto/__init__.py

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

nbdevauto-0.3.61/nbdevAuto/automate.py

@@ -1,141 +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', 'reinstall', 'update', 'release_git', 'release_pypi', 'release', 'help_output',
-           'everything', 'create_env', 'hello']
-
-# %% ../nbs/01_Automate.ipynb #6d1499d1-aa55-47d8-92fd-fa056b1fb135
-from fastcore.script import *
-
-@call_parse
-def prep(
-    p:int = 2, # Increment Part
-):
-    "Export, test, and clean notebooks, and render README if needed"
-
-    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 to github"
-    
-    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():
-    "git status"
-    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"
-    prep(p)
-    gacp(m)
-
-# %% ../nbs/01_Automate.ipynb #0f096fc0-0e97-4592-975f-e81e583b2adb
-def reinstall():
-    "runs pip install -e ."
-    import subprocess
-    subprocess.run(["pip", "install", "-e", "."])
-
-# %% ../nbs/01_Automate.ipynb #fa41bc21-ba9f-4097-8c70-4fc1404d325c
-def update():
-    "prep, then reinstall"
-    prep()
-    reinstall()
-
-# %% ../nbs/01_Automate.ipynb #dee37b06-c946-4b40-be0f-056e133751ea
-def release_git():
-    "release to git"
-    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():
-    "release to pypi"
-    import nbdev.release
-    nbdev.release.release_pypi()
-
-# %% ../nbs/01_Automate.ipynb #dd798178-9d58-457e-969a-d86a5e8bf875
-def release():
-    "release to github and pip"
-    release_git()
-    release_pypi()
-
-# %% ../nbs/01_Automate.ipynb #c4d2bd52-04c4-43fe-890b-b4cb5da8d206
-def help_output():
-    "Show help for all console scripts"
-    from fastcore.xtras import console_help
-    console_help('nbdevAuto')
-
-# %% ../nbs/01_Automate.ipynb #3606bcc9-57b1-42e7-842a-5c889485cf88
-def everything():
-    "prep, gacp, release, reinstall"
-    upload()
-    update()
-    release()
-
-# %% ../nbs/01_Automate.ipynb #8ca135ed-6377-4da1-98e8-fdab288921fb
-@call_parse
-def create_env(
-    n:str = 'fast', #Name of the environment 
-):
-    "create conda env for AI"
-    from pathlib import Path
-    import subprocess
-    
-    subprocess.run(["conda", "create", "-n", f"{n}", "python"])
-    subprocess.run(["conda", "init"])
-    subprocess.run(["conda", "activate", f"{n}"], shell=True)
-    # subprocess.run(["pip", "install", "fastai", "fastcore"])
-    
-
-# %% ../nbs/01_Automate.ipynb #16615f52-30f8-4a42-8d73-52355f2c574a
-def hello():
-    import argparse
-    parser = argparse.ArgumentParser(description='My CLI function.')
-    parser.add_argument('-n', '--name', type=str, help='Name of the environment', default='fast')
-    args = parser.parse_args()
-    
-    print(f'Hello, {args.name}!')

nbdevauto-0.3.61/nbdevAuto.egg-info/PKG-INFO

@@ -1,134 +0,0 @@
-Metadata-Version: 2.4
-Name: nbdevAuto
-Version: 0.3.61
-Summary: automating nbdev
-Author-email: Benedict Thekkel <bthekkel1@gmail.com>
-License-Expression: Apache-2.0
-Project-URL: Repository, https://github.com/bthek1/nbdevAuto
-Project-URL: Documentation, https://bthek1.github.io/nbdevAuto
-Project-URL: Issues, https://github.com/bthek1/nbdevAuto/issues
-Keywords: nbdev,jupyter,notebook,python
-Classifier: Natural Language :: English
-Classifier: Intended Audience :: Developers
-Classifier: Development Status :: 3 - Alpha
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: graphviz
-Requires-Dist: fastcore
-Provides-Extra: gh
-Requires-Dist: githubkit>=0.12; extra == "gh"
-Dynamic: license-file
-
-# nbdevAuto
-
-
-<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
-
-Unlike most sites in this collection, this one documents an
-**installable library** rather than a topic. `nbdevAuto` exists because
-the nbdev release cycle is a fixed sequence of commands typed in the
-same order every time: export the notebooks, run the tests, clean them,
-bump the version, commit, push, build the docs. Each step is one nbdev
-call, and forgetting one produces a confusing failure two steps later.
-
-The library collapses that sequence into single-word shell commands. It
-is what `just upload` and `just full_upload` invoke under the hood for
-every submodule in the parent Knowledge repo.
-
-------------------------------------------------------------------------
-
-## Install
-
-``` sh
-pip install nbdevAuto
-```
-
-## Use
-
-Every exported function is also a console script, so the common case is
-a bare word in the terminal at the root of an nbdev project:
-
-``` sh
-upload -m "commit message"    # export, test, clean, then add/commit/push
-```
-
-Or import the helpers into a notebook:
-
-``` python
-from nbdevAuto.functions import download_search_images, classify_images
-from nbdevAuto.pdf import PDFreader
-```
-
-------------------------------------------------------------------------
-
-## Contents
-
-| Page | Covers |
-|----|----|
-| [Functions](00_Functions.ipynb) | Dataset and image helpers: reading a list out of a text file, downloading single images or whole search-driven datasets, verifying and resizing what came back, building the folder layout a classifier expects, running a fastai learner over one image, Kaggle competition and dataset shortcuts, and [`graph`](https://bthek1.github.io/nbdevAuto/functions.html#graph), a `graphviz.Digraph` subclass preloaded with a rounded, filled style |
-| [Automate](01_Automate.ipynb) | The command line surface: the prep/commit/push pipeline, GitHub and PyPI releases, reinstall and update, conda environment creation, and the help output that lists them all |
-| [PDF Reader](02_PDF_reader.ipynb) | [`PDFreader`](https://bthek1.github.io/nbdevAuto/pdf_reader.html#pdfreader), a class that converts a PDF through `pdf2image` and renders page ranges inline when you slice it (`pdf[0:5]`) |
-
-------------------------------------------------------------------------
-
-## The Command Line Surface
-
-Installing the package puts these on your `PATH`. They are ordinary
-functions in [Automate](01_Automate.ipynb), exposed as scripts through
-`[project.scripts]`.
-
-| Command | Does |
-|----|----|
-| [`prep`](https://bthek1.github.io/nbdevAuto/automate.html#prep) | Export, test, and clean the notebooks, rendering the README if it needs it |
-| [`gacp`](https://bthek1.github.io/nbdevAuto/automate.html#gacp) | git add, commit, and push, with `-m` for the message |
-| [`status`](https://bthek1.github.io/nbdevAuto/automate.html#status) | Show the working tree state |
-| [`upload`](https://bthek1.github.io/nbdevAuto/automate.html#upload) | [`prep`](https://bthek1.github.io/nbdevAuto/automate.html#prep) then [`gacp`](https://bthek1.github.io/nbdevAuto/automate.html#gacp), the one you actually type |
-| [`release`](https://bthek1.github.io/nbdevAuto/automate.html#release) | Bump the version, then release to both GitHub and PyPI |
-| `gitrelease` / `piprelease` | The two halves of [`release`](https://bthek1.github.io/nbdevAuto/automate.html#release), separately |
-| [`reinstall`](https://bthek1.github.io/nbdevAuto/automate.html#reinstall) / [`update`](https://bthek1.github.io/nbdevAuto/automate.html#update) | Reinstall or update the package locally |
-| [`everything`](https://bthek1.github.io/nbdevAuto/automate.html#everything) | [`upload`](https://bthek1.github.io/nbdevAuto/automate.html#upload), [`update`](https://bthek1.github.io/nbdevAuto/automate.html#update), [`release`](https://bthek1.github.io/nbdevAuto/automate.html#release), [`reinstall`](https://bthek1.github.io/nbdevAuto/automate.html#reinstall), in that order |
-| [`create_env`](https://bthek1.github.io/nbdevAuto/automate.html#create_env) | Create a conda environment for AI work, named `fast` by default |
-| `h` | Print the list of available commands |
-
-Both [`prep`](https://bthek1.github.io/nbdevAuto/automate.html#prep) and
-[`upload`](https://bthek1.github.io/nbdevAuto/automate.html#upload) take
-`-p` to choose which version part to increment.
-
-------------------------------------------------------------------------
-
-## Where It Is Used
-
-The parent Knowledge repo’s `justfile` calls
-[`upload`](https://bthek1.github.io/nbdevAuto/automate.html#upload) once
-per submodule. `just upload` runs it only where the working tree is
-dirty, `just full_upload` runs it everywhere. That is the main consumer,
-so a change to `automate.py` affects the publish path for every site in
-the collection.
-
-------------------------------------------------------------------------
-
-## Not Covered Yet
-
-- **No test notebook.** The functions are exercised only by being used,
-  so a broken helper surfaces in a downstream repo rather than here.
-- **Undeclared dependencies.** `pyproject.toml` lists only `graphviz`,
-  but the image helpers import `fastai`, the Kaggle shortcuts need the
-  Kaggle CLI and its credentials, and
-  [`PDFreader`](https://bthek1.github.io/nbdevAuto/pdf_reader.html#pdfreader)
-  needs `pdf2image` with poppler behind it, plus matplotlib. Install
-  those yourself.
-- **`core.py` is an empty nbdev stub** (a single
-  [`foo`](https://bthek1.github.io/nbdevAuto/core.html#foo)), with no
-  notebook behind it.
-- The docstrings are one-liners, so the rendered API pages are thin. The
-  notebooks carry the real explanation.
-
-------------------------------------------------------------------------