nbdev 2.3.34__tar.gz → 3.0.6__tar.gz

{nbdev-2.3.34 → nbdev-3.0.6}/CONTRIBUTING.md

@@ -2,11 +2,21 @@
 
 ## How to get started
 
-Before anything else, please install the git hooks that run automatic scripts during each commit and merge to strip the notebooks of superfluous metadata (and avoid merge conflicts). After cloning the repository, run the following command inside it:
+Install nbdev in editable mode with development dependencies:
+```sh
+pip install -e '.[dev]'
 ```
+
+Before anything else, please install the git hooks that run automatic scripts during each commit and merge to strip the notebooks of superfluous metadata (and avoid merge conflicts). After cloning the repository, run the following command inside it:
+```sh
 nbdev_install_hooks
 ```
 
+Run the test suite to ensure everything is working:
+```sh
+nbdev_test
+```
+
 ## Did you find a bug?
 
 * Ensure the bug was not already reported by searching on GitHub under Issues.

{nbdev-2.3.34/nbdev.egg-info → nbdev-3.0.6}/PKG-INFO

@@ -1,35 +1,32 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: nbdev
-Version: 2.3.34
+Version: 3.0.6
 Summary: Create delightful software with Jupyter Notebooks
-Home-page: https://github.com/AnswerDotAI/nbdev
-Author: Jeremy Howard and Hamel Husain
-Author-email: j@fast.ai
-License: Apache Software License 2.0
+Author-email: "Jeremy Howard and the fast.ai community" <j@fast.ai>
+License: Apache-2.0
+Project-URL: Repository, https://github.com/AnswerDotAI/nbdev
 Project-URL: Documentation, https://nbdev.fast.ai/
-Keywords: nbdev fastai jupyter notebook export
+Keywords: nbdev,fastai,jupyter,notebook,export
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Natural Language :: English
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: License :: OSI Approved :: Apache Software License
-Requires-Python: >=3.7
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: packaging
-Requires-Dist: fastcore>=1.5.27
-Requires-Dist: execnb>=0.1.4
+Requires-Dist: fastcore>=1.12.3
+Requires-Dist: execnb>=0.1.12
 Requires-Dist: astunparse
 Requires-Dist: ghapi>=1.0.3
 Requires-Dist: watchdog
 Requires-Dist: asttokens
 Requires-Dist: setuptools
-Requires-Dist: PyYAML
+Requires-Dist: build
+Requires-Dist: fastgit
+Requires-Dist: pyyaml
+Requires-Dist: tomli; python_version < "3.11"
 Provides-Extra: dev
 Requires-Dist: ipywidgets; extra == "dev"
 Requires-Dist: nbdev-numpy; extra == "dev"
@@ -42,6 +39,8 @@ Requires-Dist: nbclassic; extra == "dev"
 Requires-Dist: pysymbol_llm; extra == "dev"
 Requires-Dist: llms-txt; extra == "dev"
 Requires-Dist: sphinx; extra == "dev"
+Requires-Dist: plum-dispatch; extra == "dev"
+Dynamic: license-file
 
 # Getting Started
 
@@ -50,6 +49,22 @@ Requires-Dist: sphinx; extra == "dev"
 
 ![CI](https://github.com/fastai/nbdev/actions/workflows/test.yaml/badge.svg)
 
+## 🛑**Jan 2026 Major Version Update – Breaking Change**🛑
+
+**nbdev3 is here!** As many of you have been requesting, configuration
+has moved from `settings.ini` to `pyproject.toml`, following modern
+Python packaging standards ([PEP
+621](https://peps.python.org/pep-0621/)). Your project metadata now
+lives in the standard `[project]` section, while nbdev-specific settings
+go in `[tool.nbdev]`.
+
+**Migrating from nbdev2:** Run
+[`nbdev_migrate_config`](https://nbdev.fast.ai/api/migrate.html#nbdev_migrate_config)
+in your project root to automatically convert your `settings.ini` to
+`pyproject.toml` and update your GitHub Actions workflows to use
+nbdev3-compatible versions. Your existing notebooks and code don’t need
+any changes.
+
 `nbdev` is a notebook-driven development platform. Simply write
 notebooks with lightweight markup and get high-quality documentation,
 tests, continuous integration, and packaging for free!
@@ -69,7 +84,10 @@ practices because tests and documentation are first class.
   package releases. Python best practices are automatically followed,
   for example, only exported objects are included in `__all__`
 - **Two-way sync between notebooks and plaintext source code** allowing
-  you to use your IDE for code navigation or quick edits
+  you to use your IDE for code navigation or quick edits. Sync is
+  robust: each exported cell is tagged with its unique notebook cell ID,
+  so [`nbdev_update`](https://nbdev.fast.ai/api/sync.html#nbdev_update)
+  always updates the correct cell
 - **Tests** written as ordinary notebook cells are run in parallel with
   a single command
 - **Continuous integration** out-of-the-box with [GitHub
@@ -92,12 +110,6 @@ You can install nbdev with pip:
 pip install nbdev
 ```
 
-… or with conda (or mamba):
-
-``` sh
-conda install -c fastai nbdev
-```
-
 Note that `nbdev` must be installed into the same Python environment
 that you use for both Jupyter and your project.
 
@@ -124,11 +136,13 @@ available commands:
 !nbdev_help
 ```
 
-    nbdev_bump_version        Increment version in settings.ini by one
+    nb_export                 Export a single nbdev notebook to a python script.
+    nbdev_bump_version        Increment version in __init__.py by one
     nbdev_changelog           Create a CHANGELOG.md file from closed and labeled GitHub issues
     nbdev_clean               Clean all notebooks in `fname` to avoid merge conflicts
     nbdev_conda               Create a `meta.yaml` file ready to be built into a package, and optionally build and upload it
-    nbdev_create_config       Create a config file.
+    nbdev_contributing        Create CONTRIBUTING.md from contributing_nb (defaults to 'contributing.ipynb' if present). Skips if the file doesn't exist.
+    nbdev_create_config       Create a pyproject.toml config file.
     nbdev_docs                Create Quarto docs and README.md
     nbdev_export              Export notebooks in `path` to Python modules
     nbdev_filter              A notebook filter for Quarto
@@ -139,6 +153,7 @@ available commands:
     nbdev_install_quarto      Install latest Quarto on macOS or Linux, prints instructions for Windows
     nbdev_merge               Git merge driver for notebooks
     nbdev_migrate             Convert all markdown and notebook files in `path` from v1 to v2
+    nbdev_migrate_config      Migrate settings.ini to pyproject.toml
     nbdev_new                 Create an nbdev project.
     nbdev_prepare             Export, test, and clean notebooks, and render README if needed
     nbdev_preview             Preview docs locally
@@ -148,12 +163,13 @@ available commands:
     nbdev_release_both        Release both conda and PyPI packages
     nbdev_release_gh          Calls `nbdev_changelog`, lets you edit the result, then pushes to git and calls `nbdev_release_git`
     nbdev_release_git         Tag and create a release in GitHub for the current version
-    nbdev_requirements        Writes a `requirements.txt` file to `directory` based on settings.ini.
+    nbdev_requirements        Writes a `requirements.txt` file to `directory` based on pyproject.toml.
     nbdev_sidebar             Create sidebar.yml
     nbdev_test                Test in parallel notebooks matching `path`, passing along `flags`
-    nbdev_trust               Trust notebooks matching `fname`
+    nbdev_trust               Trust notebooks matching `fname`.
     nbdev_update              Propagate change in modules matching `fname` to notebooks that created them
     nbdev_update_license      Allows you to update the license of your project.
+    watch_export              Use `nb_export` on ipynb files in `nbs` directory on changes using nbdev config if available
 
 ## FAQ
 

{nbdev-2.3.34 → nbdev-3.0.6}/README.md

@@ -5,6 +5,22 @@
 
 ![CI](https://github.com/fastai/nbdev/actions/workflows/test.yaml/badge.svg)
 
+## 🛑**Jan 2026 Major Version Update – Breaking Change**🛑
+
+**nbdev3 is here!** As many of you have been requesting, configuration
+has moved from `settings.ini` to `pyproject.toml`, following modern
+Python packaging standards ([PEP
+621](https://peps.python.org/pep-0621/)). Your project metadata now
+lives in the standard `[project]` section, while nbdev-specific settings
+go in `[tool.nbdev]`.
+
+**Migrating from nbdev2:** Run
+[`nbdev_migrate_config`](https://nbdev.fast.ai/api/migrate.html#nbdev_migrate_config)
+in your project root to automatically convert your `settings.ini` to
+`pyproject.toml` and update your GitHub Actions workflows to use
+nbdev3-compatible versions. Your existing notebooks and code don’t need
+any changes.
+
 `nbdev` is a notebook-driven development platform. Simply write
 notebooks with lightweight markup and get high-quality documentation,
 tests, continuous integration, and packaging for free!
@@ -24,7 +40,10 @@ practices because tests and documentation are first class.
   package releases. Python best practices are automatically followed,
   for example, only exported objects are included in `__all__`
 - **Two-way sync between notebooks and plaintext source code** allowing
-  you to use your IDE for code navigation or quick edits
+  you to use your IDE for code navigation or quick edits. Sync is
+  robust: each exported cell is tagged with its unique notebook cell ID,
+  so [`nbdev_update`](https://nbdev.fast.ai/api/sync.html#nbdev_update)
+  always updates the correct cell
 - **Tests** written as ordinary notebook cells are run in parallel with
   a single command
 - **Continuous integration** out-of-the-box with [GitHub
@@ -47,12 +66,6 @@ You can install nbdev with pip:
 pip install nbdev
 ```
 
-… or with conda (or mamba):
-
-``` sh
-conda install -c fastai nbdev
-```
-
 Note that `nbdev` must be installed into the same Python environment
 that you use for both Jupyter and your project.
 
@@ -79,11 +92,13 @@ available commands:
 !nbdev_help
 ```
 
-    nbdev_bump_version        Increment version in settings.ini by one
+    nb_export                 Export a single nbdev notebook to a python script.
+    nbdev_bump_version        Increment version in __init__.py by one
     nbdev_changelog           Create a CHANGELOG.md file from closed and labeled GitHub issues
     nbdev_clean               Clean all notebooks in `fname` to avoid merge conflicts
     nbdev_conda               Create a `meta.yaml` file ready to be built into a package, and optionally build and upload it
-    nbdev_create_config       Create a config file.
+    nbdev_contributing        Create CONTRIBUTING.md from contributing_nb (defaults to 'contributing.ipynb' if present). Skips if the file doesn't exist.
+    nbdev_create_config       Create a pyproject.toml config file.
     nbdev_docs                Create Quarto docs and README.md
     nbdev_export              Export notebooks in `path` to Python modules
     nbdev_filter              A notebook filter for Quarto
@@ -94,6 +109,7 @@ available commands:
     nbdev_install_quarto      Install latest Quarto on macOS or Linux, prints instructions for Windows
     nbdev_merge               Git merge driver for notebooks
     nbdev_migrate             Convert all markdown and notebook files in `path` from v1 to v2
+    nbdev_migrate_config      Migrate settings.ini to pyproject.toml
     nbdev_new                 Create an nbdev project.
     nbdev_prepare             Export, test, and clean notebooks, and render README if needed
     nbdev_preview             Preview docs locally
@@ -103,12 +119,13 @@ available commands:
     nbdev_release_both        Release both conda and PyPI packages
     nbdev_release_gh          Calls `nbdev_changelog`, lets you edit the result, then pushes to git and calls `nbdev_release_git`
     nbdev_release_git         Tag and create a release in GitHub for the current version
-    nbdev_requirements        Writes a `requirements.txt` file to `directory` based on settings.ini.
+    nbdev_requirements        Writes a `requirements.txt` file to `directory` based on pyproject.toml.
     nbdev_sidebar             Create sidebar.yml
     nbdev_test                Test in parallel notebooks matching `path`, passing along `flags`
-    nbdev_trust               Trust notebooks matching `fname`
+    nbdev_trust               Trust notebooks matching `fname`.
     nbdev_update              Propagate change in modules matching `fname` to notebooks that created them
     nbdev_update_license      Allows you to update the license of your project.
+    watch_export              Use `nb_export` on ipynb files in `nbs` directory on changes using nbdev config if available
 
 ## FAQ
 

{nbdev-2.3.34 → nbdev-3.0.6}/nbdev/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "2.3.34"
+__version__ = "3.0.6"
 
 from .doclinks import nbdev_export
 from .showdoc import show_doc

{nbdev-2.3.34 → nbdev-3.0.6}/nbdev/_modidx.py

@@ -1,6 +1,6 @@
 # Autogenerated by nbdev
 
-d = { 'settings': { 'branch': 'master',
+d = { 'settings': { 'branch': 'main',
                 'doc_baseurl': '/',
                 'doc_host': 'https://nbdev.fast.ai',
                 'git_url': 'https://github.com/AnswerDotAI/nbdev',
@@ -28,26 +28,42 @@ d = { 'settings': { 'branch': 'master',
                            'nbdev.cli.nbdev_new': ('api/cli.html#nbdev_new', 'nbdev/cli.py'),
                            'nbdev.cli.nbdev_update_license': ('api/cli.html#nbdev_update_license', 'nbdev/cli.py'),
                            'nbdev.cli.watch_export': ('api/cli.html#watch_export', 'nbdev/cli.py')},
-            'nbdev.config': { 'nbdev.config._apply_defaults': ('api/config.html#_apply_defaults', 'nbdev/config.py'),
+            'nbdev.config': { 'nbdev.config.ConfigToml': ('api/config.html#configtoml', 'nbdev/config.py'),
+                              'nbdev.config.ConfigToml.__getattr__': ('api/config.html#configtoml.__getattr__', 'nbdev/config.py'),
+                              'nbdev.config.ConfigToml.__getitem__': ('api/config.html#configtoml.__getitem__', 'nbdev/config.py'),
+                              'nbdev.config.ConfigToml.__init__': ('api/config.html#configtoml.__init__', 'nbdev/config.py'),
+                              'nbdev.config.ConfigToml.d': ('api/config.html#configtoml.d', 'nbdev/config.py'),
+                              'nbdev.config.ConfigToml.get': ('api/config.html#configtoml.get', 'nbdev/config.py'),
+                              'nbdev.config.ConfigToml.path': ('api/config.html#configtoml.path', 'nbdev/config.py'),
+                              'nbdev.config.ConfigToml.version': ('api/config.html#configtoml.version', 'nbdev/config.py'),
                               'nbdev.config._basic_export_nb': ('api/config.html#_basic_export_nb', 'nbdev/config.py'),
-                              'nbdev.config._cfg2txt': ('api/config.html#_cfg2txt', 'nbdev/config.py'),
                               'nbdev.config._fetch_from_git': ('api/config.html#_fetch_from_git', 'nbdev/config.py'),
+                              'nbdev.config._find_nbdev_pyproject': ('api/config.html#_find_nbdev_pyproject', 'nbdev/config.py'),
                               'nbdev.config._get_info': ('api/config.html#_get_info', 'nbdev/config.py'),
                               'nbdev.config._git_repo': ('api/config.html#_git_repo', 'nbdev/config.py'),
+                              'nbdev.config._has_nbdev': ('api/config.html#_has_nbdev', 'nbdev/config.py'),
                               'nbdev.config._has_py': ('api/config.html#_has_py', 'nbdev/config.py'),
-                              'nbdev.config._nbdev_config_file': ('api/config.html#_nbdev_config_file', 'nbdev/config.py'),
-                              'nbdev.config._prompt_user': ('api/config.html#_prompt_user', 'nbdev/config.py'),
-                              'nbdev.config._type': ('api/config.html#_type', 'nbdev/config.py'),
-                              'nbdev.config._xdg_config_paths': ('api/config.html#_xdg_config_paths', 'nbdev/config.py'),
+                              'nbdev.config._load_toml': ('api/config.html#_load_toml', 'nbdev/config.py'),
+                              'nbdev.config._user_config': ('api/config.html#_user_config', 'nbdev/config.py'),
                               'nbdev.config.add_init': ('api/config.html#add_init', 'nbdev/config.py'),
-                              'nbdev.config.config_key': ('api/config.html#config_key', 'nbdev/config.py'),
+                              'nbdev.config.bump_version': ('api/config.html#bump_version', 'nbdev/config.py'),
                               'nbdev.config.create_output': ('api/config.html#create_output', 'nbdev/config.py'),
                               'nbdev.config.get_config': ('api/config.html#get_config', 'nbdev/config.py'),
                               'nbdev.config.is_nbdev': ('api/config.html#is_nbdev', 'nbdev/config.py'),
                               'nbdev.config.nbdev_create_config': ('api/config.html#nbdev_create_config', 'nbdev/config.py'),
+                              'nbdev.config.read_version': ('api/config.html#read_version', 'nbdev/config.py'),
+                              'nbdev.config.set_version': ('api/config.html#set_version', 'nbdev/config.py'),
                               'nbdev.config.show_src': ('api/config.html#show_src', 'nbdev/config.py'),
+                              'nbdev.config.update_proj': ('api/config.html#update_proj', 'nbdev/config.py'),
                               'nbdev.config.update_version': ('api/config.html#update_version', 'nbdev/config.py'),
                               'nbdev.config.write_cells': ('api/config.html#write_cells', 'nbdev/config.py')},
+            'nbdev.diff': { 'nbdev.diff._cell_changes': ('api/diff.html#_cell_changes', 'nbdev/diff.py'),
+                            'nbdev.diff._nb_srcdict': ('api/diff.html#_nb_srcdict', 'nbdev/diff.py'),
+                            'nbdev.diff.cell_diffs': ('api/diff.html#cell_diffs', 'nbdev/diff.py'),
+                            'nbdev.diff.changed_cells': ('api/diff.html#changed_cells', 'nbdev/diff.py'),
+                            'nbdev.diff.nbs_pair': ('api/diff.html#nbs_pair', 'nbdev/diff.py'),
+                            'nbdev.diff.read_nb_from_git': ('api/diff.html#read_nb_from_git', 'nbdev/diff.py'),
+                            'nbdev.diff.source_diff': ('api/diff.html#source_diff', 'nbdev/diff.py')},
             'nbdev.doclinks': { 'nbdev.doclinks.NbdevLookup': ('api/doclinks.html#nbdevlookup', 'nbdev/doclinks.py'),
                                 'nbdev.doclinks.NbdevLookup.__getitem__': ( 'api/doclinks.html#nbdevlookup.__getitem__',
                                                                             'nbdev/doclinks.py'),
@@ -137,15 +153,20 @@ d = { 'settings': { 'branch': 'master',
                              'nbdev.merge.unpatch': ('api/merge.html#unpatch', 'nbdev/merge.py')},
             'nbdev.migrate': { 'nbdev.migrate.MigrateProc': ('api/migrate.html#migrateproc', 'nbdev/migrate.py'),
                                'nbdev.migrate.MigrateProc.begin': ('api/migrate.html#migrateproc.begin', 'nbdev/migrate.py'),
+                               'nbdev.migrate._build_classifiers': ('api/migrate.html#_build_classifiers', 'nbdev/migrate.py'),
                                'nbdev.migrate._cat_slug': ('api/migrate.html#_cat_slug', 'nbdev/migrate.py'),
                                'nbdev.migrate._co': ('api/migrate.html#_co', 'nbdev/migrate.py'),
                                'nbdev.migrate._convert_callout': ('api/migrate.html#_convert_callout', 'nbdev/migrate.py'),
                                'nbdev.migrate._convert_video': ('api/migrate.html#_convert_video', 'nbdev/migrate.py'),
                                'nbdev.migrate._file_slug': ('api/migrate.html#_file_slug', 'nbdev/migrate.py'),
+                               'nbdev.migrate._fmt_script': ('api/migrate.html#_fmt_script', 'nbdev/migrate.py'),
                                'nbdev.migrate._fp_convert': ('api/migrate.html#_fp_convert', 'nbdev/migrate.py'),
                                'nbdev.migrate._fp_fm': ('api/migrate.html#_fp_fm', 'nbdev/migrate.py'),
                                'nbdev.migrate._fp_image': ('api/migrate.html#_fp_image', 'nbdev/migrate.py'),
                                'nbdev.migrate._is_jekyll_post': ('api/migrate.html#_is_jekyll_post', 'nbdev/migrate.py'),
+                               'nbdev.migrate._migrate_workflows': ('api/migrate.html#_migrate_workflows', 'nbdev/migrate.py'),
+                               'nbdev.migrate._nbdev_migrate_config': ('api/migrate.html#_nbdev_migrate_config', 'nbdev/migrate.py'),
+                               'nbdev.migrate._py_val': ('api/migrate.html#_py_val', 'nbdev/migrate.py'),
                                'nbdev.migrate._re_v1': ('api/migrate.html#_re_v1', 'nbdev/migrate.py'),
                                'nbdev.migrate._repl_directives': ('api/migrate.html#_repl_directives', 'nbdev/migrate.py'),
                                'nbdev.migrate._repl_v1dir': ('api/migrate.html#_repl_v1dir', 'nbdev/migrate.py'),
@@ -153,11 +174,13 @@ d = { 'settings': { 'branch': 'master',
                                'nbdev.migrate._replace_fm': ('api/migrate.html#_replace_fm', 'nbdev/migrate.py'),
                                'nbdev.migrate._rm_quote': ('api/migrate.html#_rm_quote', 'nbdev/migrate.py'),
                                'nbdev.migrate._subv1': ('api/migrate.html#_subv1', 'nbdev/migrate.py'),
+                               'nbdev.migrate._toml_val': ('api/migrate.html#_toml_val', 'nbdev/migrate.py'),
                                'nbdev.migrate._v': ('api/migrate.html#_v', 'nbdev/migrate.py'),
                                'nbdev.migrate.fp_md_fm': ('api/migrate.html#fp_md_fm', 'nbdev/migrate.py'),
                                'nbdev.migrate.migrate_md': ('api/migrate.html#migrate_md', 'nbdev/migrate.py'),
                                'nbdev.migrate.migrate_nb': ('api/migrate.html#migrate_nb', 'nbdev/migrate.py'),
-                               'nbdev.migrate.nbdev_migrate': ('api/migrate.html#nbdev_migrate', 'nbdev/migrate.py')},
+                               'nbdev.migrate.nbdev_migrate': ('api/migrate.html#nbdev_migrate', 'nbdev/migrate.py'),
+                               'nbdev.migrate.nbdev_migrate_config': ('api/migrate.html#nbdev_migrate_config', 'nbdev/migrate.py')},
             'nbdev.process': { 'nbdev.process.NBProcessor': ('api/process.html#nbprocessor', 'nbdev/process.py'),
                                'nbdev.process.NBProcessor.__init__': ('api/process.html#nbprocessor.__init__', 'nbdev/process.py'),
                                'nbdev.process.NBProcessor._proc': ('api/process.html#nbprocessor._proc', 'nbdev/process.py'),
@@ -257,20 +280,22 @@ d = { 'settings': { 'branch': 'master',
                               'nbdev.quarto._SidebarYmlRemoved.__init__': ( 'api/quarto.html#_sidebarymlremoved.__init__',
                                                                             'nbdev/quarto.py'),
                               'nbdev.quarto._copytree': ('api/quarto.html#_copytree', 'nbdev/quarto.py'),
+                              'nbdev.quarto._doc_mtime_not_older': ('api/quarto.html#_doc_mtime_not_older', 'nbdev/quarto.py'),
                               'nbdev.quarto._ensure_quarto': ('api/quarto.html#_ensure_quarto', 'nbdev/quarto.py'),
                               'nbdev.quarto._install_linux': ('api/quarto.html#_install_linux', 'nbdev/quarto.py'),
                               'nbdev.quarto._install_mac': ('api/quarto.html#_install_mac', 'nbdev/quarto.py'),
                               'nbdev.quarto._nbglob_docs': ('api/quarto.html#_nbglob_docs', 'nbdev/quarto.py'),
                               'nbdev.quarto._pre': ('api/quarto.html#_pre', 'nbdev/quarto.py'),
                               'nbdev.quarto._pre_docs': ('api/quarto.html#_pre_docs', 'nbdev/quarto.py'),
-                              'nbdev.quarto._readme_mtime_not_older': ('api/quarto.html#_readme_mtime_not_older', 'nbdev/quarto.py'),
                               'nbdev.quarto._recursive_parser': ('api/quarto.html#_recursive_parser', 'nbdev/quarto.py'),
+                              'nbdev.quarto._save_cached_contributing': ('api/quarto.html#_save_cached_contributing', 'nbdev/quarto.py'),
                               'nbdev.quarto._save_cached_readme': ('api/quarto.html#_save_cached_readme', 'nbdev/quarto.py'),
                               'nbdev.quarto._sort': ('api/quarto.html#_sort', 'nbdev/quarto.py'),
                               'nbdev.quarto._sprun': ('api/quarto.html#_sprun', 'nbdev/quarto.py'),
                               'nbdev.quarto.fs_watchdog': ('api/quarto.html#fs_watchdog', 'nbdev/quarto.py'),
                               'nbdev.quarto.install': ('api/quarto.html#install', 'nbdev/quarto.py'),
                               'nbdev.quarto.install_quarto': ('api/quarto.html#install_quarto', 'nbdev/quarto.py'),
+                              'nbdev.quarto.nbdev_contributing': ('api/quarto.html#nbdev_contributing', 'nbdev/quarto.py'),
                               'nbdev.quarto.nbdev_docs': ('api/quarto.html#nbdev_docs', 'nbdev/quarto.py'),
                               'nbdev.quarto.nbdev_preview': ('api/quarto.html#nbdev_preview', 'nbdev/quarto.py'),
                               'nbdev.quarto.nbdev_proc_nbs': ('api/quarto.html#nbdev_proc_nbs', 'nbdev/quarto.py'),
@@ -293,12 +318,12 @@ d = { 'settings': { 'branch': 'master',
                                'nbdev.release._run': ('api/release.html#_run', 'nbdev/release.py'),
                                'nbdev.release._write_yaml': ('api/release.html#_write_yaml', 'nbdev/release.py'),
                                'nbdev.release.anaconda_upload': ('api/release.html#anaconda_upload', 'nbdev/release.py'),
-                               'nbdev.release.bump_version': ('api/release.html#bump_version', 'nbdev/release.py'),
                                'nbdev.release.changelog': ('api/release.html#changelog', 'nbdev/release.py'),
                                'nbdev.release.chk_conda_rel': ('api/release.html#chk_conda_rel', 'nbdev/release.py'),
                                'nbdev.release.conda_output_path': ('api/release.html#conda_output_path', 'nbdev/release.py'),
                                'nbdev.release.latest_pypi': ('api/release.html#latest_pypi', 'nbdev/release.py'),
                                'nbdev.release.nbdev_bump_version': ('api/release.html#nbdev_bump_version', 'nbdev/release.py'),
+                               'nbdev.release.push_release': ('api/release.html#push_release', 'nbdev/release.py'),
                                'nbdev.release.pypi_details': ('api/release.html#pypi_details', 'nbdev/release.py'),
                                'nbdev.release.pypi_json': ('api/release.html#pypi_json', 'nbdev/release.py'),
                                'nbdev.release.release_both': ('api/release.html#release_both', 'nbdev/release.py'),
@@ -312,44 +337,10 @@ d = { 'settings': { 'branch': 'master',
                              'nbdev.serve._proc_file': ('api/serve.html#_proc_file', 'nbdev/serve.py'),
                              'nbdev.serve.proc_nbs': ('api/serve.html#proc_nbs', 'nbdev/serve.py')},
             'nbdev.serve_drv': {},
-            'nbdev.showdoc': { 'nbdev.showdoc.BasicHtmlRenderer': ('api/showdoc.html#basichtmlrenderer', 'nbdev/showdoc.py'),
-                               'nbdev.showdoc.BasicHtmlRenderer._repr_html_': ( 'api/showdoc.html#basichtmlrenderer._repr_html_',
-                                                                                'nbdev/showdoc.py'),
-                               'nbdev.showdoc.BasicHtmlRenderer.doc': ('api/showdoc.html#basichtmlrenderer.doc', 'nbdev/showdoc.py'),
-                               'nbdev.showdoc.BasicMarkdownRenderer': ('api/showdoc.html#basicmarkdownrenderer', 'nbdev/showdoc.py'),
+            'nbdev.showdoc': { 'nbdev.showdoc.BasicMarkdownRenderer': ('api/showdoc.html#basicmarkdownrenderer', 'nbdev/showdoc.py'),
                                'nbdev.showdoc.BasicMarkdownRenderer._repr_markdown_': ( 'api/showdoc.html#basicmarkdownrenderer._repr_markdown_',
                                                                                         'nbdev/showdoc.py'),
-                               'nbdev.showdoc.DocmentTbl': ('api/showdoc.html#docmenttbl', 'nbdev/showdoc.py'),
-                               'nbdev.showdoc.DocmentTbl.__eq__': ('api/showdoc.html#docmenttbl.__eq__', 'nbdev/showdoc.py'),
-                               'nbdev.showdoc.DocmentTbl.__init__': ('api/showdoc.html#docmenttbl.__init__', 'nbdev/showdoc.py'),
-                               'nbdev.showdoc.DocmentTbl._columns': ('api/showdoc.html#docmenttbl._columns', 'nbdev/showdoc.py'),
-                               'nbdev.showdoc.DocmentTbl._hdr_list': ('api/showdoc.html#docmenttbl._hdr_list', 'nbdev/showdoc.py'),
-                               'nbdev.showdoc.DocmentTbl._repr_markdown_': ( 'api/showdoc.html#docmenttbl._repr_markdown_',
-                                                                             'nbdev/showdoc.py'),
-                               'nbdev.showdoc.DocmentTbl._row': ('api/showdoc.html#docmenttbl._row', 'nbdev/showdoc.py'),
-                               'nbdev.showdoc.DocmentTbl._row_list': ('api/showdoc.html#docmenttbl._row_list', 'nbdev/showdoc.py'),
-                               'nbdev.showdoc.DocmentTbl.has_docment': ('api/showdoc.html#docmenttbl.has_docment', 'nbdev/showdoc.py'),
-                               'nbdev.showdoc.DocmentTbl.has_return': ('api/showdoc.html#docmenttbl.has_return', 'nbdev/showdoc.py'),
-                               'nbdev.showdoc.DocmentTbl.hdr_str': ('api/showdoc.html#docmenttbl.hdr_str', 'nbdev/showdoc.py'),
-                               'nbdev.showdoc.DocmentTbl.params_str': ('api/showdoc.html#docmenttbl.params_str', 'nbdev/showdoc.py'),
-                               'nbdev.showdoc.DocmentTbl.return_str': ('api/showdoc.html#docmenttbl.return_str', 'nbdev/showdoc.py'),
-                               'nbdev.showdoc.ShowDocRenderer': ('api/showdoc.html#showdocrenderer', 'nbdev/showdoc.py'),
-                               'nbdev.showdoc.ShowDocRenderer.__init__': ('api/showdoc.html#showdocrenderer.__init__', 'nbdev/showdoc.py'),
-                               'nbdev.showdoc._bold': ('api/showdoc.html#_bold', 'nbdev/showdoc.py'),
-                               'nbdev.showdoc._create_html_table': ('api/showdoc.html#_create_html_table', 'nbdev/showdoc.py'),
-                               'nbdev.showdoc._docstring': ('api/showdoc.html#_docstring', 'nbdev/showdoc.py'),
-                               'nbdev.showdoc._escape_markdown': ('api/showdoc.html#_escape_markdown', 'nbdev/showdoc.py'),
                                'nbdev.showdoc._ext_link': ('api/showdoc.html#_ext_link', 'nbdev/showdoc.py'),
-                               'nbdev.showdoc._f_name': ('api/showdoc.html#_f_name', 'nbdev/showdoc.py'),
-                               'nbdev.showdoc._fmt_anno': ('api/showdoc.html#_fmt_anno', 'nbdev/showdoc.py'),
-                               'nbdev.showdoc._fmt_sig': ('api/showdoc.html#_fmt_sig', 'nbdev/showdoc.py'),
-                               'nbdev.showdoc._fullname': ('api/showdoc.html#_fullname', 'nbdev/showdoc.py'),
-                               'nbdev.showdoc._html_link': ('api/showdoc.html#_html_link', 'nbdev/showdoc.py'),
-                               'nbdev.showdoc._list2row': ('api/showdoc.html#_list2row', 'nbdev/showdoc.py'),
-                               'nbdev.showdoc._maybe_nm': ('api/showdoc.html#_maybe_nm', 'nbdev/showdoc.py'),
-                               'nbdev.showdoc._non_empty_keys': ('api/showdoc.html#_non_empty_keys', 'nbdev/showdoc.py'),
-                               'nbdev.showdoc._show_param': ('api/showdoc.html#_show_param', 'nbdev/showdoc.py'),
-                               'nbdev.showdoc._wrap_sig': ('api/showdoc.html#_wrap_sig', 'nbdev/showdoc.py'),
                                'nbdev.showdoc.colab_link': ('api/showdoc.html#colab_link', 'nbdev/showdoc.py'),
                                'nbdev.showdoc.doc': ('api/showdoc.html#doc', 'nbdev/showdoc.py'),
                                'nbdev.showdoc.show_doc': ('api/showdoc.html#show_doc', 'nbdev/showdoc.py'),

{nbdev-2.3.34 → nbdev-3.0.6}/nbdev/clean.py

@@ -2,31 +2,31 @@
 
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/11_clean.ipynb.
 
-# %% auto 0
+# %% auto #0
 __all__ = ['nbdev_trust', 'clean_nb', 'process_write', 'nbdev_clean', 'clean_jupyter', 'nbdev_install_hooks']
 
-# %% ../nbs/api/11_clean.ipynb
+# %% ../nbs/api/11_clean.ipynb #07637414
 import ast,warnings,stat
 from astunparse import unparse
 from textwrap import indent
 
 from execnb.nbio import *
 from fastcore.script import *
-from fastcore.basics import *
-from fastcore.imports import *
+from fastcore.utils import *
+from fastcore.xtras import *
 
 from .imports import *
 from .config import *
 from .sync import *
 from .process import first_code_ln
 
-# %% ../nbs/api/11_clean.ipynb
+# %% ../nbs/api/11_clean.ipynb #4259f92c
 @call_parse
 def nbdev_trust(
     fname:str=None,  # A notebook name or glob to trust
     force_all:bool=False  # Also trust notebooks that haven't changed
 ):
-    "Trust notebooks matching `fname`"
+    "Trust notebooks matching `fname`."
     try: from nbformat.sign import NotebookNotary
     except:
         import warnings
@@ -47,7 +47,7 @@ def nbdev_trust(
         if not NotebookNotary().check_signature(nb): NotebookNotary().sign(nb)
     check_fname.touch(exist_ok=True)
 
-# %% ../nbs/api/11_clean.ipynb
+# %% ../nbs/api/11_clean.ipynb #a2ba2b4c
 _repr_id_re = re.compile('(<.*?)( at 0x[0-9a-fA-F]+)(>)')
 
 _sub = partial(_repr_id_re.sub, r'\1\3')
@@ -57,7 +57,7 @@ def _skip_or_sub(x): return _sub(x) if "at 0x" in x else x
 def _clean_cell_output_id(lines):
     return _skip_or_sub(lines) if isinstance(lines,str) else [_skip_or_sub(o) for o in lines]
 
-# %% ../nbs/api/11_clean.ipynb
+# %% ../nbs/api/11_clean.ipynb #b4cde615
 def _clean_cell_output(cell, clean_ids):
     "Remove `cell` output execution count and optionally ids from text reprs"
     outputs = cell.get('outputs', [])
@@ -69,9 +69,9 @@ def _clean_cell_output(cell, clean_ids):
             if k.startswith('text') and clean_ids: data[k] = _clean_cell_output_id(data[k])
             if k.startswith('image') and "svg" not in k: data[k] = data[k].rstrip()
         if 'text' in o and clean_ids: o['text'] = _clean_cell_output_id(o['text'])
-        o.get('metadata', {}).pop('tags', None)
+#         o.get('metadata', {}).pop('tags', None)
 
-# %% ../nbs/api/11_clean.ipynb
+# %% ../nbs/api/11_clean.ipynb #2ba79c93
 def _clean_cell(cell, clear_all, allowed_metadata_keys, clean_ids):
     "Clean `cell` by removing superfluous metadata or everything except the input if `clear_all`"
     if 'execution_count' in cell: cell['execution_count'] = None
@@ -81,8 +81,9 @@ def _clean_cell(cell, clear_all, allowed_metadata_keys, clean_ids):
     if cell['source'] == ['']: cell['source'] = []
     cell['metadata'] = {} if clear_all else {
         k:v for k,v in cell['metadata'].items() if k in allowed_metadata_keys}
+    if 'id' not in cell: cell['id'] = rtoken_hex(4)
 
-# %% ../nbs/api/11_clean.ipynb
+# %% ../nbs/api/11_clean.ipynb #e8101222
 def clean_nb(
     nb, # The notebook to clean
     clear_all=False, # Remove all cell metadata and cell outputs?
@@ -99,13 +100,15 @@ def clean_nb(
     if nb.get('metadata', {}).get('kernelspec', {}).get('name', None):
         nb['metadata']['kernelspec']['display_name'] = nb["metadata"]["kernelspec"]["name"]
     nb['metadata'] = {k:v for k,v in nb['metadata'].items() if k in metadata_keys}
+    # Cell IDs were added in nbformat 4.5
+    if nb.get('nbformat') == 4 and nb.get('nbformat_minor', 0) < 5: nb['nbformat_minor'] = 5
 
-# %% ../nbs/api/11_clean.ipynb
+# %% ../nbs/api/11_clean.ipynb #604d83e6
 def _reconfigure(*strms):
     for s in strms:
         if hasattr(s,'reconfigure'): s.reconfigure(encoding='utf-8')
 
-# %% ../nbs/api/11_clean.ipynb
+# %% ../nbs/api/11_clean.ipynb #d251837f
 def process_write(warn_msg, proc_nb, f_in, f_out=None, disp=False):
     if not f_out: f_out = f_in
     if isinstance(f_in, (str,Path)): f_in = Path(f_in).open(encoding="utf-8")
@@ -118,16 +121,16 @@ def process_write(warn_msg, proc_nb, f_in, f_out=None, disp=False):
         warn(f'{warn_msg}')
         warn(e)
 
-# %% ../nbs/api/11_clean.ipynb
+# %% ../nbs/api/11_clean.ipynb #714357ce
 def _nbdev_clean(nb, path=None, clear_all=None):
     cfg = get_config(path=path)
     clear_all = clear_all or cfg.clear_all
-    allowed_metadata_keys = cfg.get("allowed_metadata_keys").split()
-    allowed_cell_metadata_keys = cfg.get("allowed_cell_metadata_keys").split()
+    allowed_metadata_keys = cfg.get("allowed_metadata_keys") or []
+    allowed_cell_metadata_keys = cfg.get("allowed_cell_metadata_keys") or []
     clean_nb(nb, clear_all, allowed_metadata_keys, allowed_cell_metadata_keys, cfg.clean_ids)
     if path: nbdev_trust.__wrapped__(path)
 
-# %% ../nbs/api/11_clean.ipynb
+# %% ../nbs/api/11_clean.ipynb #6af3b9d4
 @call_parse
 def nbdev_clean(
     fname:str=None, # A notebook name or glob to clean
@@ -143,15 +146,14 @@ def nbdev_clean(
     if fname is None: fname = get_config().nbs_path
     for f in globtastic(fname, file_glob='*.ipynb', skip_folder_re='^[_.]'): _write(f_in=f, disp=disp)
 
-# %% ../nbs/api/11_clean.ipynb
+# %% ../nbs/api/11_clean.ipynb #f84289fc
 def clean_jupyter(path, model, **kwargs):
     "Clean Jupyter `model` pre save to `path`"
     if not (model['type']=='notebook' and model['content']['nbformat']==4): return
-    get_config.cache_clear() # Allow config changes without restarting Jupyter
     jupyter_hooks = get_config(path=path).jupyter_hooks
     if jupyter_hooks: _nbdev_clean(model['content'], path=path)
 
-# %% ../nbs/api/11_clean.ipynb
+# %% ../nbs/api/11_clean.ipynb #b7c19563
 _pre_save_hook_src = '''
 def nbdev_clean_jupyter(**kwargs):
     try: from nbdev.clean import clean_jupyter
@@ -161,7 +163,7 @@ def nbdev_clean_jupyter(**kwargs):
 c.ContentsManager.pre_save_hook = nbdev_clean_jupyter'''.strip()
 _pre_save_hook_re = re.compile(r'c\.(File)?ContentsManager\.pre_save_hook')
 
-# %% ../nbs/api/11_clean.ipynb
+# %% ../nbs/api/11_clean.ipynb #fcb8df4b
 def _add_jupyter_hooks(src, path):
     if _pre_save_hook_src in src: return
     mod = ast.parse(src)
@@ -179,12 +181,12 @@ def _add_jupyter_hooks(src, path):
     if src: src+='\n\n'
     return src+_pre_save_hook_src
 
-# %% ../nbs/api/11_clean.ipynb
+# %% ../nbs/api/11_clean.ipynb #cc677e44
 def _git_root(): 
     try: return Path(run('git rev-parse --show-toplevel'))
     except OSError: return None
 
-# %% ../nbs/api/11_clean.ipynb
+# %% ../nbs/api/11_clean.ipynb #e6083614
 @call_parse
 def nbdev_install_hooks():
     "Install Jupyter and git hooks to automatically clean, trust, and fix merge conflicts in notebooks"