nbdev 2.3.30__tar.gz → 2.3.32__tar.gz

{nbdev-2.3.30/nbdev.egg-info → nbdev-2.3.32}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nbdev
-Version: 2.3.30
+Version: 2.3.32
 Summary: Create delightful software with Jupyter Notebooks
 Home-page: https://github.com/fastai/nbdev
 Author: Jeremy Howard and Hamel Husain
@@ -28,6 +28,7 @@ Requires-Dist: astunparse
 Requires-Dist: ghapi>=1.0.3
 Requires-Dist: watchdog
 Requires-Dist: asttokens
+Requires-Dist: setuptools
 Requires-Dist: PyYAML
 Provides-Extra: dev
 Requires-Dist: ipywidgets; extra == "dev"
@@ -38,6 +39,8 @@ Requires-Dist: matplotlib; extra == "dev"
 Requires-Dist: black; extra == "dev"
 Requires-Dist: svg.py; extra == "dev"
 Requires-Dist: nbclassic; extra == "dev"
+Requires-Dist: pysymbol_llm; extra == "dev"
+Requires-Dist: llms-txt; extra == "dev"
 
 # Getting Started
 

{nbdev-2.3.30 → nbdev-2.3.32}/nbdev/__init__.py

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

{nbdev-2.3.30 → nbdev-2.3.32}/nbdev/_modidx.py

@@ -23,9 +23,11 @@ d = { 'settings': { 'branch': 'master',
                            'nbdev.cli._update_repo_meta': ('api/cli.html#_update_repo_meta', 'nbdev/cli.py'),
                            'nbdev.cli.chelp': ('api/cli.html#chelp', 'nbdev/cli.py'),
                            'nbdev.cli.extract_tgz': ('api/cli.html#extract_tgz', 'nbdev/cli.py'),
+                           'nbdev.cli.nb_export_cli': ('api/cli.html#nb_export_cli', 'nbdev/cli.py'),
                            'nbdev.cli.nbdev_filter': ('api/cli.html#nbdev_filter', 'nbdev/cli.py'),
                            '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.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._basic_export_nb': ('api/config.html#_basic_export_nb', 'nbdev/config.py'),
                               'nbdev.config._cfg2txt': ('api/config.html#_cfg2txt', 'nbdev/config.py'),
@@ -41,6 +43,7 @@ d = { 'settings': { 'branch': 'master',
                               'nbdev.config.config_key': ('api/config.html#config_key', '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.show_src': ('api/config.html#show_src', 'nbdev/config.py'),
                               'nbdev.config.update_version': ('api/config.html#update_version', 'nbdev/config.py'),
@@ -331,6 +334,7 @@ d = { 'settings': { 'branch': 'master',
                                '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-2.3.30 → nbdev-2.3.32}/nbdev/cli.py

@@ -5,6 +5,7 @@
 # %% ../nbs/api/13_cli.ipynb 2
 from __future__ import annotations
 import warnings
+import time
 
 from .config import *
 from .process import *
@@ -12,9 +13,11 @@ from .processors import *
 from .doclinks import *
 from .test import *
 from .clean import *
-from .quarto import nbdev_readme, refresh_quarto_yml
+from .quarto import nbdev_readme, refresh_quarto_yml, fs_watchdog
+from .export import nb_export
 from .frontmatter import FrontmatterProc
 
+from fastcore.xtras import run
 from execnb.nbio import *
 from fastcore.meta import *
 from fastcore.utils import *
@@ -27,7 +30,8 @@ from contextlib import redirect_stdout
 import os, tarfile, sys
 
 # %% auto 0
-__all__ = ['mapping', 'nbdev_filter', 'extract_tgz', 'nbdev_new', 'nbdev_update_license', 'chelp']
+__all__ = ['mapping', 'nbdev_filter', 'extract_tgz', 'nbdev_new', 'nbdev_update_license', 'nb_export_cli', 'watch_export',
+           'chelp']
 
 # %% ../nbs/api/13_cli.ipynb
 @call_parse
@@ -158,6 +162,34 @@ def nbdev_update_license(
     lic.write(body)
     print(f"License updated from {curr_lic} to {to}")
 
+# %% ../nbs/api/13_cli.ipynb
+@call_parse
+@delegates(nb_export, but=['procs', 'mod_maker'])
+def nb_export_cli(nbname, 
+                  debug:store_true=False, # Debug flag 
+                  **kwargs): 
+    "Export a single nbdev notebook to a python script."
+    return nb_export(nbname=nbname, debug=debug, **kwargs)
+
+# %% ../nbs/api/13_cli.ipynb
+@call_parse
+def watch_export(nbs:str=None, # Nb directory to watch for changes
+                 lib:str=None, # Export directory to write py files to
+                 force:bool=False # Ignore nbdev config if in nbdev project
+                ):
+    '''Use `nb_export` on ipynb files in `nbs` directory on changes using nbdev config if available'''
+    cfg = get_config() if is_nbdev() else None
+    nbs = nbs or (cfg.nbs_path if cfg else '.')
+    lib = lib or (cfg.lib_path if cfg else '.')
+    if cfg and (nbs != cfg.nbs_path or lib != cfg.lib_path) and not force:
+        raise ValueError("In nbdev project. Use --force to override config.")
+    def _export(e,lib=lib):
+        p = e.src_path
+        if (not '.ipynb_checkpoints' in p and p.endswith('.ipynb') and not Path(p).name.startswith('.~')):
+            if e.event_type == 'modified': run(f'nb_export --lib_path {lib} "{p}"')
+    with fs_watchdog(_export, nbs):
+        while True: time.sleep(1)
+
 # %% ../nbs/api/13_cli.ipynb
 @call_parse
 def chelp():

{nbdev-2.3.30 → nbdev-2.3.32}/nbdev/config.py

@@ -3,8 +3,8 @@
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/01_config.ipynb.
 
 # %% auto 0
-__all__ = ['nbdev_create_config', 'get_config', 'config_key', 'create_output', 'show_src', 'update_version', 'add_init',
-           'write_cells']
+__all__ = ['nbdev_create_config', 'get_config', 'config_key', 'is_nbdev', 'create_output', 'show_src', 'update_version',
+           'add_init', 'write_cells']
 
 # %% ../nbs/api/01_config.ipynb
 from datetime import datetime
@@ -181,10 +181,8 @@ def nbdev_create_config(
 
 # %% ../nbs/api/01_config.ipynb
 def _nbdev_config_file(cfg_name=_nbdev_cfg_name, path=None):
-    cfg_path = path = Path.cwd() if path is None else Path(path)
-    while cfg_path != cfg_path.parent and not (cfg_path/cfg_name).exists(): cfg_path = cfg_path.parent
-    if not (cfg_path/cfg_name).exists(): cfg_path = path
-    return cfg_path/cfg_name
+    cfg_path = Path.cwd() if path is None else Path(path)
+    return getattr(Config.find(cfg_name), 'config_file', cfg_path/cfg_name)
 
 # %% ../nbs/api/01_config.ipynb
 def _xdg_config_paths(cfg_name=_nbdev_cfg_name):
@@ -209,6 +207,9 @@ def config_key(c, default=None, path=True, missing_ok=None):
     warn("`config_key` is deprecated. Use `get_config().get` or `get_config().path` instead.", DeprecationWarning)
     return get_config().path(c, default) if path else get_config().get(c, default)
 
+# %% ../nbs/api/01_config.ipynb
+def is_nbdev(): return _nbdev_config_file().exists()
+
 # %% ../nbs/api/01_config.ipynb
 def create_output(txt, mime):
     "Add a cell output containing `txt` of the `mime` text MIME sub-type"

{nbdev-2.3.30 → nbdev-2.3.32}/nbdev/doclinks.py

@@ -143,9 +143,10 @@ def nbdev_export(
     **kwargs):
     "Export notebooks in `path` to Python modules"
     if os.environ.get('IN_TEST',0): return
+    if not is_nbdev(): raise Exception('`nbdev_export` must be called from a directory within a nbdev project.')
     if procs:
-      import nbdev.export
-      procs = [getattr(nbdev.export, p) for p in L(procs)]
+        import nbdev.export
+        procs = [getattr(nbdev.export, p) for p in L(procs)]
     files = nbglob(path=path, as_path=True, **kwargs).sorted('name')
     for f in files: nb_export(f, procs=procs)
     add_init(get_config().lib_path)
@@ -194,7 +195,7 @@ def _qual_syms(entries):
     return {'syms': {mod:_qual_mod(d, settings) for mod,d in entries['syms'].items()}, 'settings':settings}
 
 # %% ../nbs/api/05_doclinks.ipynb
-_re_backticks = re.compile(r'`([^`\s]+)`')
+_re_backticks = re.compile(r'`([^`\s]+?)(?:\(\))?`')
 
 # %% ../nbs/api/05_doclinks.ipynb
 @lru_cache(None)
@@ -235,12 +236,13 @@ class NbdevLookup:
         _,py,gh = res
         line = _lineno(sym, py)
         return f'{gh}#L{line}'
-
+    
     def _link_sym(self, m):
         l = m.group(1)
         s = self.doc(l)
         if s is None: return m.group(0)
         l = l.replace('\\', r'\\')
+        if m.group(0).endswith('()`'): l += '()'
         return rf"[`{l}`]({s})"
 
     def link_line(self, l): return _re_backticks.sub(self._link_sym, l)

{nbdev-2.3.30 → nbdev-2.3.32}/nbdev/export.py

@@ -14,6 +14,7 @@ from .process import *
 from fastcore.script import *
 from fastcore.basics import *
 from fastcore.imports import *
+from fastcore.meta import *
 
 from collections import defaultdict
 
@@ -63,12 +64,18 @@ import nbdev.export
 def optional_procs():
     "An explicit list of processors that could be used by `nb_export`"
     return L([p for p in nbdev.export.__all__
-              if p not in ["nb_export", "ExportModuleProc", "optional_procs"]])
+              if p not in ["nb_export", "nb_export_cli", "ExportModuleProc", "optional_procs"]])
 
 # %% ../nbs/api/04_export.ipynb
-def nb_export(nbname, lib_path=None, procs=None, debug=False, mod_maker=ModuleMaker, name=None):
+def nb_export(nbname:str,        # Filename of notebook 
+              lib_path:str=None, # Path to destination library.  If not in a nbdev project, defaults to current directory.
+              procs=None,        # Processors to use
+              name:str=None,     # Name of python script {name}.py to create.
+              mod_maker=ModuleMaker,
+              debug:bool=False,  # Debug mode
+             ):
     "Create module(s) from notebook"
-    if lib_path is None: lib_path = get_config().lib_path
+    if lib_path is None: lib_path = get_config().lib_path if is_nbdev() else '.'
     exp = ExportModuleProc()
     nb = NBProcessor(nbname, [exp]+L(procs), debug=debug)
     nb.process()

{nbdev-2.3.30 → nbdev-2.3.32}/nbdev/migrate.py

@@ -112,7 +112,7 @@ def _re_v1():
     d += L(get_config().tst_flags).filter()
     d += [s.replace('_', '-') for s in d] # allow for hyphenated version of old directives
     _tmp = '|'.join(list(set(d)))
-    return re.compile(f"^[ \f\v\t]*?(#)\s*({_tmp})(?!\S)", re.MULTILINE)
+    return re.compile(fr"^[ \f\v\t]*?(#)\s*({_tmp})(?!\S)", re.MULTILINE)
 
 def _repl_directives(code_str): 
     def _fmt(x): return f"#| {_subv1(x[2].replace('-', '_').strip())}"

{nbdev-2.3.30 → nbdev-2.3.32}/nbdev/processors.py

@@ -206,7 +206,7 @@ _re_showdoc = re.compile(r'^show_doc', re.MULTILINE)
 def _is_showdoc(cell): return cell['cell_type'] == 'code' and _re_showdoc.search(cell.source)
 def _add_directives(cell, d):
     for k,v in d.items():
-        if not re.findall(f'#\| *{k}:', cell.source): cell.source = f'#| {k}: {v}\n' + cell.source
+        if not re.findall(fr'#\| *{k}:', cell.source): cell.source = f'#| {k}: {v}\n' + cell.source
 
 def clean_show_doc(cell):
     "Remove ShowDoc input cells"

{nbdev-2.3.30 → nbdev-2.3.32}/nbdev/quarto.py

@@ -89,7 +89,7 @@ def _recursive_parser(
         set_index: bool = True): # If `True`, `index` file will be set to href.
     for name, val in dir_dict.items():
         if type(val) is str:
-            if re.search('index\..*', re.sub(r'^\d+_', '', val)) and set_index and section:
+            if re.search(r'index\..*', re.sub(r'^\d+_', '', val)) and set_index and section:
                 section.update({'href': str(dirpath/val)})
             else:
                 contents.append(str(dirpath/val))
@@ -110,7 +110,7 @@ def nbdev_sidebar(
     path:str=None, # Path to notebooks
     printit:bool=False,  # Print YAML for debugging
     force:bool=False,  # Create sidebar even if settings.ini custom_sidebar=False
-    skip_folder_re:str='(?:^[_.]|^www\$)', # Skip folders matching regex
+    skip_folder_re:str=r'(?:^[_.]|^www\$)', # Skip folders matching regex
     **kwargs):
     "Create sidebar.yml"
     if not force and get_config().custom_sidebar: return

{nbdev-2.3.30 → nbdev-2.3.32}/nbdev/release.py

@@ -288,7 +288,7 @@ def release_conda(
     if skip_upload: return print(loc)
     if not upload_user: upload_user = get_config().conda_user
     if not upload_user: return print("`conda_user` not in settings.ini and no `upload_user` passed. Cannot upload")
-    if 'anaconda upload' not in res: return print(f"{res}\n\Failed. Check auto-upload not set in .condarc. Try `--do_build False`.")
+    if 'anaconda upload' not in res: return print(f"{res}\n\nFailed. Check auto-upload not set in .condarc. Try `--do_build False`.")
     return anaconda_upload(name, loc)
 
 # %% ../nbs/api/18_release.ipynb

{nbdev-2.3.30 → nbdev-2.3.32}/nbdev/showdoc.py

@@ -192,24 +192,47 @@ def show_doc(sym,  # Symbol to document
     if isinstance(sym, TypeDispatch): pass
     else:return renderer(sym or show_doc, name=name, title_level=title_level)
 
+# %% ../nbs/api/08_showdoc.ipynb
+def _create_html_table(table_str):
+    def split_row(row):
+        return re.findall(r'\|(?:(?:\\.|[^|\\])*)', row)
+    
+    def unescape_cell(cell): 
+        return cell.strip(' *|').replace(r'\|', '|')
+    
+    lines = table_str.strip().split('\n')
+    header = [f"<th>{unescape_cell(cell)}</th>" for cell in split_row(lines[0])]
+    rows = [[f"<td>{unescape_cell(cell)}</td>" for cell in split_row(line)] for line in lines[2:]]
+    
+    return f'''<table>
+    <thead><tr>{' '.join(header)}</tr></thead>
+    <tbody>{''.join(f'<tr>{" ".join(row)}</tr>' for row in rows)}</tbody>
+    </table>'''
+
 # %% ../nbs/api/08_showdoc.ipynb
 def _html_link(url, txt): return f'<a href="{url}" target="_blank" rel="noreferrer noopener">{txt}</a>'
 
+# %% ../nbs/api/08_showdoc.ipynb
 class BasicHtmlRenderer(ShowDocRenderer):
-    "Simple HTML renderer for `show_doc`"
+    "HTML renderer for `show_doc`"
     def _repr_html_(self):
         doc = '<hr/>\n'
+        src = NbdevLookup().code(self.fn)
         doc += f'<h{self.title_level}>{self.nm}</h{self.title_level}>\n'
-        doc += f'<blockquote><pre><code>{self.nm}{_fmt_sig(self.sig)}</code></pre></blockquote>'
-        if self.docs: doc += f"<p><i>{self.docs}</i></p>"
+        sig = _fmt_sig(self.sig) if self.sig else ''
+        # Escape < and > characters in the signature
+        sig = sig.replace('<', '&lt;').replace('>', '&gt;')
+        doc += f'<blockquote><pre><code>{self.nm} {sig}</code></pre></blockquote>'
+        if self.docs:
+            doc += f"<p><i>{self.docs}</i></p>"
+        if src: doc += f"<br/>{_html_link(src, 'source')}"
+        if self.dm.has_docment: doc += _create_html_table(str(self.dm))
         return doc
 
     def doc(self):
         "Show `show_doc` info along with link to docs"
         from IPython.display import display,HTML
         res = self._repr_html_()
-        docs = NbdevLookup().doc(self.fn)
-        if docs is not None: res += '\n<p>' +_html_link(docs, "Show in docs") + '</p>'
         display(HTML(res))
 
 # %% ../nbs/api/08_showdoc.ipynb

{nbdev-2.3.30 → nbdev-2.3.32}/nbdev/sync.py

@@ -19,7 +19,7 @@ from fastcore.script import *
 from fastcore.xtras import *
 
 import ast
-from importlib import import_module
+import importlib
 
 # %% ../nbs/api/06_sync.ipynb
 def absolute_import(name, fname, level):
@@ -32,7 +32,10 @@ def absolute_import(name, fname, level):
 # %% ../nbs/api/06_sync.ipynb
 @functools.lru_cache(maxsize=None)
 def _mod_files():
-    midx = import_module(f'{get_config().lib_path.name}._modidx')
+    midx_spec = importlib.util.spec_from_file_location("_modidx", get_config().lib_path / "_modidx.py")
+    midx = importlib.util.module_from_spec(midx_spec)
+    midx_spec.loader.exec_module(midx)
+
     return L(files for mod in midx.d['syms'].values() for _,files in mod.values()).unique()
 
 # %% ../nbs/api/06_sync.ipynb

{nbdev-2.3.30 → nbdev-2.3.32/nbdev.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nbdev
-Version: 2.3.30
+Version: 2.3.32
 Summary: Create delightful software with Jupyter Notebooks
 Home-page: https://github.com/fastai/nbdev
 Author: Jeremy Howard and Hamel Husain
@@ -28,6 +28,7 @@ Requires-Dist: astunparse
 Requires-Dist: ghapi>=1.0.3
 Requires-Dist: watchdog
 Requires-Dist: asttokens
+Requires-Dist: setuptools
 Requires-Dist: PyYAML
 Provides-Extra: dev
 Requires-Dist: ipywidgets; extra == "dev"
@@ -38,6 +39,8 @@ Requires-Dist: matplotlib; extra == "dev"
 Requires-Dist: black; extra == "dev"
 Requires-Dist: svg.py; extra == "dev"
 Requires-Dist: nbclassic; extra == "dev"
+Requires-Dist: pysymbol_llm; extra == "dev"
+Requires-Dist: llms-txt; extra == "dev"
 
 # Getting Started
 

{nbdev-2.3.30 → nbdev-2.3.32}/nbdev.egg-info/SOURCES.txt

@@ -2,6 +2,7 @@ CONTRIBUTING.md
 LICENSE
 MANIFEST.in
 README.md
+pyproject.toml
 settings.ini
 setup.py
 nbdev/__init__.py

{nbdev-2.3.30 → nbdev-2.3.32}/nbdev.egg-info/entry_points.txt

@@ -1,4 +1,5 @@
 [console_scripts]
+nb_export = nbdev.cli:nb_export_cli
 nbdev_bump_version = nbdev.release:nbdev_bump_version
 nbdev_changelog = nbdev.release:changelog
 nbdev_clean = nbdev.clean:nbdev_clean
@@ -29,6 +30,7 @@ nbdev_test = nbdev.test:nbdev_test
 nbdev_trust = nbdev.clean:nbdev_trust
 nbdev_update = nbdev.sync:nbdev_update
 nbdev_update_license = nbdev.cli:nbdev_update_license
+watch_export = nbdev.cli:watch_export
 
 [nbdev]
 nbdev = nbdev._modidx:d

{nbdev-2.3.30 → nbdev-2.3.32}/nbdev.egg-info/requires.txt

@@ -5,6 +5,7 @@ astunparse
 ghapi>=1.0.3
 watchdog
 asttokens
+setuptools
 PyYAML
 
 [dev]
@@ -16,3 +17,5 @@ matplotlib
 black
 svg.py
 nbclassic
+pysymbol_llm
+llms-txt

nbdev-2.3.32/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools>=64.0"]
+build-backend = "setuptools.build_meta"

{nbdev-2.3.30 → nbdev-2.3.32}/settings.ini

@@ -9,17 +9,17 @@ author = Jeremy Howard and Hamel Husain
 author_email = j@fast.ai
 branch = master
 min_python = 3.7
-version = 2.3.30
+version = 2.3.32
 audience = Developers
 language = English
 custom_sidebar = True
 license = apache2
 status = 5
-requirements = fastcore>=1.5.27 execnb>=0.1.4 astunparse ghapi>=1.0.3 watchdog asttokens
+requirements = fastcore>=1.5.27 execnb>=0.1.4 astunparse ghapi>=1.0.3 watchdog asttokens setuptools
 pip_requirements = PyYAML
 conda_requirements = pyyaml
 conda_user = fastai
-dev_requirements = ipywidgets nbdev-numpy nbdev-stdlib pandas matplotlib black svg.py nbclassic
+dev_requirements = ipywidgets nbdev-numpy nbdev-stdlib pandas matplotlib black svg.py nbclassic pysymbol_llm llms-txt
 console_scripts = nbdev_create_config=nbdev.config:nbdev_create_config
 	nbdev_update=nbdev.sync:nbdev_update
 	nbdev_update_license=nbdev.cli:nbdev_update_license
@@ -50,6 +50,8 @@ console_scripts = nbdev_create_config=nbdev.config:nbdev_create_config
 	nbdev_requirements=nbdev.release:write_requirements
 	nbdev_proc_nbs=nbdev.quarto:nbdev_proc_nbs
 	nbdev_help=nbdev.cli:chelp
+    nb_export=nbdev.cli:nb_export_cli
+    watch_export=nbdev.cli:watch_export
 tst_flags = notest
 nbs_path = nbs
 doc_path = _docs
@@ -68,4 +70,5 @@ clean_ids = False
 clear_all = False
 cell_number = False
 put_version_in_init = True
+skip_procs =