nbdevAuto

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

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:

upload -m "commit message"    # export, test, clean, then add/commit/push

Or import the helpers into a notebook:

from nbdevAuto.functions import download_search_images, classify_images
from nbdevAuto.pdf import PDFreader

Contents

Page Covers
Functions 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, a graphviz.Digraph subclass preloaded with a rounded, filled style
Automate 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 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, exposed as scripts through [project.scripts].

Command Does
prep Export, test, and clean the notebooks, rendering the README if it needs it
gacp git add, commit, and push, with -m for the message
status Show the working tree state
upload prep then gacp, the one you actually type
release Bump the version, then release to both GitHub and PyPI
gitrelease / piprelease The two halves of release, separately
reinstall / update Reinstall or update the package locally
everything upload, update, release, reinstall, in that order
create_env Create a conda environment for AI work, named fast by default
h Print the list of available commands

Both prep and upload take -p to choose which version part to increment.

Where It Is Used

The parent Knowledge repo’s justfile calls 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 needs pdf2image with poppler behind it, plus matplotlib. Install those yourself.
  • core.py is an empty nbdev stub (a single foo), with no notebook behind it.
  • The docstrings are one-liners, so the rendered API pages are thin. The notebooks carry the real explanation.

Project links

Data verified by PyPI on Aug 26, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.3.69)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for bthek1 from gravatar.com bthek1

Credits

Author: Benedict Thekkel

GitHub Statistics

Data verified by PyPI on Aug 26, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

Apache-2.0
View SPDX License List

Requires

Python >=3.10

Provides Extra

gh

Tags

nbdev jupyter notebook python

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nbdevauto-0.3.61.tar.gz (22.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nbdevauto-0.3.61-py3-none-any.whl (22.4 kB view details)

Uploaded Python 3

File details

Details for the file nbdevauto-0.3.61.tar.gz.

File metadata

  • Download URL: nbdevauto-0.3.61.tar.gz
  • Upload date:
  • Size: 22.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for nbdevauto-0.3.61.tar.gz
Algorithm Hash digest
SHA256 07ef6f06a2364b8cbd35e85d18d6ad480707ab8235fda454d264c08fab064175
MD5 3f310b317ad0342dc36c1703cfde7c36
BLAKE2b-256 ff2d8721e1596b3d39dc170ab0f2ec79dedd3df41ee1ae09fd4003680b77390c

See more details on using hashes here.

Provenance

The following attestation bundles were made for nbdevauto-0.3.61.tar.gz:

Publisher: publish.yaml on bthek1/nbdevAuto

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file nbdevauto-0.3.61-py3-none-any.whl.

File metadata

  • Download URL: nbdevauto-0.3.61-py3-none-any.whl
  • Upload date:
  • Size: 22.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for nbdevauto-0.3.61-py3-none-any.whl
Algorithm Hash digest
SHA256 9c3d05c3dcef608fa96d4d57f20a4621db89c197305f5a9a1775f929a6f465ae
MD5 44868c0d64ea440dfb163ae26d45f8a7
BLAKE2b-256 9e64040851181e9fe33cfe9ccae28ead2343f3f82504bdb535938271736833b1

See more details on using hashes here.

Provenance

The following attestation bundles were made for nbdevauto-0.3.61-py3-none-any.whl:

Publisher: publish.yaml on bthek1/nbdevAuto

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.3.69

2 files

0.3.68

2 files

0.3.67

2 files

0.3.66

2 files

0.3.65

2 files

0.3.64

2 files

0.3.63

2 files

This release

0.3.61 This release

2 files

0.3.60

2 files

0.3.26

2 files

0.3.23

2 files

0.0.130

2 files

0.0.119

2 files

0.0.112

2 files

0.0.110

2 files

0.0.108

2 files

0.0.104

2 files

0.0.102

2 files

0.0.100

2 files

0.0.95

2 files

0.0.93

2 files

0.0.90

2 files

0.0.81

2 files

0.0.76

2 files

0.0.74

2 files

0.0.72

2 files

0.0.70

2 files

0.0.67

2 files

0.0.64

2 files

0.0.62

2 files

0.0.60

2 files

0.0.57

2 files

0.0.52

2 files

0.0.51

2 files

0.0.44

2 files

0.0.41

2 files

0.0.34

2 files

0.0.33

2 files

0.0.32

2 files

0.0.30

2 files

0.0.28

2 files

0.0.27

2 files

0.0.25

2 files

0.0.22

2 files

0.0.21

2 files

0.0.20

2 files

0.0.18

2 files

0.0.17

2 files

0.0.16

2 files

0.0.15

2 files

0.0.14

2 files

0.0.13

2 files

0.0.12

2 files

0.0.11

2 files

0.0.10

2 files

0.0.9

2 files

0.0.8

2 files

0.0.7

2 files

0.0.6

2 files

0.0.5

2 files

0.0.4

2 files

0.0.3

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page