nbdev 2.3.34__tar.gz → 2.3.35__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nbdev
-Version: 2.3.34
+Version: 2.3.35
 Summary: Create delightful software with Jupyter Notebooks
 Home-page: https://github.com/AnswerDotAI/nbdev
 Author: Jeremy Howard and Hamel Husain
@@ -23,7 +23,7 @@ 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: execnb>=0.1.12
 Requires-Dist: astunparse
 Requires-Dist: ghapi>=1.0.3
 Requires-Dist: watchdog

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

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

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

@@ -257,20 +257,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'),

{nbdev-2.3.34 → nbdev-2.3.35}/nbdev/cli.py

@@ -13,7 +13,7 @@ from .processors import *
 from .doclinks import *
 from .test import *
 from .clean import *
-from .quarto import nbdev_readme, refresh_quarto_yml, fs_watchdog
+from .quarto import nbdev_readme, nbdev_contributing, refresh_quarto_yml, fs_watchdog
 from .export import nb_export
 from .frontmatter import FrontmatterProc
 
@@ -91,7 +91,7 @@ def nbdev_new(**kwargs):
     _update_repo_meta(cfg)
     path = Path()
 
-    _ORG_OR_USR,_REPOSITORY = 'fastai','nbdev-template'
+    _ORG_OR_USR,_REPOSITORY = 'answerdotai','nbdev-template'
     _TEMPLATE = f'{_ORG_OR_USR}/{_REPOSITORY}'
     template = kwargs.get('template', _TEMPLATE)
     try: org_or_usr, repo = template.split('/')
@@ -121,6 +121,7 @@ def nbdev_new(**kwargs):
     refresh_quarto_yml()
     nbdev_export.__wrapped__()
     nbdev_readme.__wrapped__()
+    nbdev_contributing.__wrapped__()
 
 # %% ../nbs/api/13_cli.ipynb
 mapping = {

{nbdev-2.3.34 → nbdev-2.3.35}/nbdev/config.py

@@ -249,12 +249,12 @@ def add_init(path=None):
     if get_config().get('put_version_in_init', True): update_version(path)
 
 # %% ../nbs/api/01_config.ipynb
-def write_cells(cells, hdr, file, offset=0, cell_number=True):
+def write_cells(cells, hdr, file, offset=0, cell_number=True, solo_nb=False):
     "Write `cells` to `file` along with header `hdr` starting at index `offset` (mainly for nbdev internal use)."
     for cell in cells:
         if cell.cell_type=='code' and cell.source.strip():
             idx = f" {cell.idx_+offset}" if cell_number else ""
-            file.write(f'\n\n{hdr}{idx}\n{cell.source}')
+            file.write(f'\n\n{hdr}{idx}\n{cell.source}') if not solo_nb else file.write(f'\n\n{cell.source}')
 
 # %% ../nbs/api/01_config.ipynb
 def _basic_export_nb(fname, name, dest=None):

{nbdev-2.3.34 → nbdev-2.3.35}/nbdev/doclinks.py

@@ -244,9 +244,12 @@ def _build_lookup_table(strip_libs=None, incl_libs=None, skip_mods=None):
     for m in strip_libs:
         if m in entries:
             _d = entries[m]
-            stripped = {remove_prefix(k,f"{mod}."):v
-                        for mod,dets in _d['syms'].items() if mod not in skip_mods
-                        for k,v in dets.items()}
+            stripped = {}
+            for mod, dets in _d['syms'].items():
+                if mod not in skip_mods:
+                    for k,v in dets.items():
+                        k = remove_prefix(k,f"{mod}.")
+                        if k not in stripped: stripped[k] = v
             py_syms = merge(stripped, py_syms)
     return entries,py_syms
 

{nbdev-2.3.34 → nbdev-2.3.35}/nbdev/export.py

@@ -73,6 +73,7 @@ def nb_export(nbname:str,        # Filename of notebook
               name:str=None,     # Name of python script {name}.py to create.
               mod_maker=ModuleMaker,
               debug:bool=False,  # Debug mode
+              solo_nb:bool=False # Export single notebook outside of an nbdev project.
              ):
     "Create module(s) from notebook"
     if lib_path is None: lib_path = get_config().lib_path if is_nbdev() else '.'
@@ -88,5 +89,5 @@ def nb_export(nbname:str,        # Filename of notebook
                      "Note nbdev2 no longer supports nbdev1 syntax. Run `nbdev_migrate` to upgrade.\n"
                      "See https://nbdev.fast.ai/getting_started.html for more information.")
                 return
-            mm = mod_maker(dest=lib_path, name=nm, nb_path=nbname, is_new=bool(name) or mod=='#')
+            mm = mod_maker(dest=lib_path, name=nm, nb_path=nbname, is_new=bool(name) or mod=='#', solo_nb=solo_nb)
             mm.make(cells, all_cells, lib_path=lib_path)

{nbdev-2.3.34 → nbdev-2.3.35}/nbdev/maker.py

@@ -63,7 +63,7 @@ def update_var(varname, func, fn=None, code=None):
 # %% ../nbs/api/02_maker.ipynb
 class ModuleMaker:
     "Helper class to create exported library from notebook source cells"
-    def __init__(self, dest, name, nb_path, is_new=True, parse=True):
+    def __init__(self, dest, name, nb_path, is_new=True, parse=True, solo_nb=False):
         dest,nb_path = Path(dest),Path(nb_path)
         store_attr()
         self.fname = dest/(name.replace('.','/') + ".py")
@@ -208,8 +208,8 @@ def make(self:ModuleMaker, cells, all_cells=None, lib_path=None):
         f.write(_retr_mdoc(cells))
         f.write(f"# AUTOGENERATED! DO NOT EDIT! File to edit: {self.dest2nb}.")
         if last_future > 0: write_cells(cells[:last_future], self.hdr, f)
-        if self.parse: f.write(f"\n\n# %% auto 0\n__all__ = {all_str}")
-        write_cells(cells[last_future:], self.hdr, f, cell_number=get_config().cell_number)
+        if self.parse and not self.solo_nb: f.write(f"\n\n# %% auto 0\n__all__ = {all_str}")
+        write_cells(cells[last_future:], self.hdr, f, cell_number=get_config().cell_number, solo_nb=self.solo_nb)
         f.write('\n')
 
 # %% ../nbs/api/02_maker.ipynb

{nbdev-2.3.34 → nbdev-2.3.35}/nbdev/quarto.py

@@ -21,7 +21,8 @@ import yaml
 
 # %% auto 0
 __all__ = ['BASE_QUARTO_URL', 'install_quarto', 'install', 'IndentDumper', 'nbdev_sidebar', 'refresh_quarto_yml',
-           'nbdev_proc_nbs', 'nbdev_readme', 'nbdev_docs', 'prepare', 'fs_watchdog', 'nbdev_preview']
+           'nbdev_proc_nbs', 'nbdev_readme', 'nbdev_contributing', 'nbdev_docs', 'prepare', 'fs_watchdog',
+           'nbdev_preview']
 
 # %% ../nbs/api/14_quarto.ipynb
 def _sprun(cmd):
@@ -214,7 +215,7 @@ def nbdev_proc_nbs(**kwargs):
     _pre_docs(**kwargs)[0]
 
 # %% ../nbs/api/14_quarto.ipynb
-def _readme_mtime_not_older(readme_path, readme_nb_path):
+def _doc_mtime_not_older(readme_path, readme_nb_path):
     if not readme_nb_path.exists():
         print(f"Could not find {readme_nb_path}")
         return True
@@ -259,7 +260,7 @@ def nbdev_readme(
     "Create README.md from readme_nb (index.ipynb by default)"
     cfg = get_config()
     path = Path(path) if path else cfg.nbs_path
-    if chk_time and _readme_mtime_not_older(cfg.config_path/'README.md', path/cfg.readme_nb): return
+    if chk_time and _doc_mtime_not_older(cfg.config_path/'README.md', path/cfg.readme_nb): return
 
     with _SidebarYmlRemoved(path): # to avoid rendering whole website
         cache = proc_nbs(path)
@@ -267,6 +268,38 @@ def nbdev_readme(
         
     _save_cached_readme(cache, cfg)
 
+# %% ../nbs/api/14_quarto.ipynb
+def _save_cached_contributing(cache, cfg, contrib_nb):
+    "Move CONTRIBUTING.md (and any `_files` assets) from the Quarto build cache to the repo root."
+    tmp_doc_path = cache / cfg.doc_path.name
+    contrib_file = tmp_doc_path / 'CONTRIBUTING.md'
+    if contrib_file.exists():
+        final_path = cfg.config_path / 'CONTRIBUTING.md'
+        if final_path.exists(): final_path.unlink() # py37 doesn't have `missing_ok`
+        move(contrib_file, final_path)
+        assets_folder = tmp_doc_path / (Path(contrib_nb).stem + '_files') # Supporting files for CONTRIBUTING
+        if assets_folder.exists(): _copytree(assets_folder, cfg.config_path / assets_folder.name)
+
+# %% ../nbs/api/14_quarto.ipynb
+@call_parse
+def nbdev_contributing(
+    path:str=None,  # Path to notebooks
+    chk_time:bool=False  # Only build if out-of-date
+):
+    """Create CONTRIBUTING.md from contributing_nb (defaults to 'contributing.ipynb' if present). Skips if the file doesn't exist."""
+    cfg = get_config()
+    path = Path(path) if path else cfg.nbs_path
+    contrib_nb_name = cfg.get('contributing_nb', 'contributing.ipynb')
+    contrib_nb_path = path / contrib_nb_name
+    if not contrib_nb_path.exists(): return
+    if chk_time and _doc_mtime_not_older(cfg.config_path / 'CONTRIBUTING.md' , contrib_nb_path): return
+    
+    with _SidebarYmlRemoved(path): # to avoid rendering whole website
+        cache = proc_nbs(path)
+        _sprun(f'cd "{cache}" && quarto render "{cache/contrib_nb_name}" -o CONTRIBUTING.md -t gfm --no-execute')
+        
+    _save_cached_contributing(cache, cfg, contrib_nb_name)
+
 # %% ../nbs/api/14_quarto.ipynb
 @call_parse
 @delegates(_nbglob_docs)
@@ -277,6 +310,7 @@ def nbdev_docs(
     "Create Quarto docs and README.md"
     cache,cfg,path = _pre_docs(path, n_workers=n_workers, **kwargs)
     nbdev_readme.__wrapped__(path=path, chk_time=True)
+    nbdev_contributing.__wrapped__(path=path, chk_time=True)
     _sprun(f'cd "{cache}" && quarto render --no-cache')
     shutil.rmtree(cfg.doc_path, ignore_errors=True)
     move(cache/cfg.doc_path.name, cfg.config_path)
@@ -291,6 +325,7 @@ def prepare():
     nbdev.clean.nbdev_clean.__wrapped__()
     refresh_quarto_yml()
     nbdev_readme.__wrapped__(chk_time=True)
+    nbdev_contributing.__wrapped__(chk_time=True)
 
 # %% ../nbs/api/14_quarto.ipynb
 @contextmanager

{nbdev-2.3.34 → nbdev-2.3.35}/nbdev/release.py

@@ -3,9 +3,9 @@
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/18_release.ipynb.
 
 # %% auto 0
-__all__ = ['GH_HOST', 'Release', 'changelog', 'release_git', 'release_gh', 'pypi_json', 'latest_pypi', 'pypi_details',
-           'conda_output_path', 'write_conda_meta', 'write_requirements', 'anaconda_upload', 'release_conda',
-           'chk_conda_rel', 'release_pypi', 'release_both', 'bump_version', 'nbdev_bump_version']
+__all__ = ['GH_HOST', 'CONDA_WARNING', 'Release', 'changelog', 'release_git', 'release_gh', 'pypi_json', 'latest_pypi',
+           'pypi_details', 'conda_output_path', 'write_conda_meta', 'write_requirements', 'anaconda_upload',
+           'release_conda', 'chk_conda_rel', 'release_pypi', 'release_both', 'bump_version', 'nbdev_bump_version']
 
 # %% ../nbs/api/18_release.ipynb
 from fastcore.all import *
@@ -251,8 +251,11 @@ def write_requirements(path:str=''):
     (d/'requirements.txt').mk_write(req)
 
 # %% ../nbs/api/18_release.ipynb
+CONDA_WARNING='Conda support for nbdev is deprecated and scheduled for removal in a future version.'
+
 def anaconda_upload(name, loc=None, user=None, token=None, env_token=None):
     "Upload `name` to anaconda"
+    warn(CONDA_WARNING)
     user = f'-u {user} ' if user else ''
     if env_token: token = os.getenv(env_token)
     token = f'-t {token} ' if token else ''
@@ -271,6 +274,7 @@ def release_conda(
     upload_user:str=None  # Optional user to upload package to
 ):
     "Create a `meta.yaml` file ready to be built into a package, and optionally build and upload it"
+    warn(CONDA_WARNING)
     name = get_config().lib_name
     write_conda_meta(path)
     out = f"Done. Next steps:\n```\ncd {path}\n"""

{nbdev-2.3.34 → nbdev-2.3.35}/nbdev/serve.py

@@ -36,7 +36,7 @@ def _is_qpy(path:Path):
 
 # %% ../nbs/api/17_serve.ipynb
 def _proc_file(s, cache, path, mtime=None):
-    skips = ('_proc', '_docs', '_site')
+    skips = ('_proc', '_docs', '_site', 'settings.ini')
     if not s.is_file() or any(o[0]=='.' or o in skips for o in s.parts): return
     d = cache/s.relative_to(path)
     if s.suffix=='.py': d = d.with_suffix('')
@@ -66,6 +66,7 @@ def proc_nbs(
     path = Path(path or cfg.nbs_path)
     files = nbglob(path, func=Path, file_glob='', file_re='', **kwargs)
     if (path/'_quarto.yml').exists(): files.append(path/'_quarto.yml')
+    if (path/'_brand.yml').exists(): files.append(path/'_brand.yml')
     if (path/'_extensions').exists(): files.extend(nbglob(path/'_extensions', func=Path, file_glob='', file_re='', skip_file_re='^[.]'))
 
     # If settings.ini or filter script newer than cache folder modified, delete cache

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nbdev
-Version: 2.3.34
+Version: 2.3.35
 Summary: Create delightful software with Jupyter Notebooks
 Home-page: https://github.com/AnswerDotAI/nbdev
 Author: Jeremy Howard and Hamel Husain
@@ -23,7 +23,7 @@ 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: execnb>=0.1.12
 Requires-Dist: astunparse
 Requires-Dist: ghapi>=1.0.3
 Requires-Dist: watchdog

{nbdev-2.3.34 → nbdev-2.3.35}/nbdev.egg-info/entry_points.txt

@@ -4,6 +4,7 @@ nbdev_bump_version = nbdev.release:nbdev_bump_version
 nbdev_changelog = nbdev.release:changelog
 nbdev_clean = nbdev.clean:nbdev_clean
 nbdev_conda = nbdev.release:release_conda
+nbdev_contributing = nbdev.quarto:nbdev_contributing
 nbdev_create_config = nbdev.config:nbdev_create_config
 nbdev_docs = nbdev.quarto:nbdev_docs
 nbdev_export = nbdev.doclinks:nbdev_export

{nbdev-2.3.34 → nbdev-2.3.35}/nbdev.egg-info/requires.txt

@@ -1,6 +1,6 @@
 packaging
 fastcore>=1.5.27
-execnb>=0.1.4
+execnb>=0.1.12
 astunparse
 ghapi>=1.0.3
 watchdog

{nbdev-2.3.34 → nbdev-2.3.35}/settings.ini

@@ -9,13 +9,13 @@ author = Jeremy Howard and Hamel Husain
 author_email = j@fast.ai
 branch = master
 min_python = 3.7
-version = 2.3.34
+version = 2.3.35
 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 setuptools
+requirements = fastcore>=1.5.27 execnb>=0.1.12 astunparse ghapi>=1.0.3 watchdog asttokens setuptools
 pip_requirements = PyYAML
 conda_requirements = pyyaml
 conda_user = fastai
@@ -40,6 +40,7 @@ console_scripts = nbdev_create_config=nbdev.config:nbdev_create_config
 	nbdev_preview=nbdev.quarto:nbdev_preview
 	nbdev_prepare=nbdev.quarto:prepare
 	nbdev_readme=nbdev.quarto:nbdev_readme
+	nbdev_contributing=nbdev.quarto:nbdev_contributing
 	nbdev_release_gh=nbdev.release:release_gh
 	nbdev_release_git=nbdev.release:release_git
 	nbdev_changelog=nbdev.release:changelog