nbdev 2.4.13__tar.gz → 3.0.0__tar.gz

{nbdev-2.4.13/nbdev.egg-info → nbdev-3.0.0}/PKG-INFO

@@ -1,26 +1,22 @@
 Metadata-Version: 2.4
 Name: nbdev
-Version: 2.4.13
+Version: 3.0.0
 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.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.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: packaging
-Requires-Dist: fastcore>=1.12.1
+Requires-Dist: fastcore>=1.12.3
 Requires-Dist: execnb>=0.1.12
 Requires-Dist: astunparse
 Requires-Dist: ghapi>=1.0.3
@@ -29,7 +25,8 @@ Requires-Dist: asttokens
 Requires-Dist: setuptools
 Requires-Dist: build
 Requires-Dist: fastgit
-Requires-Dist: PyYAML
+Requires-Dist: pyyaml
+Requires-Dist: tomli; python_version < "3.11"
 Provides-Extra: dev
 Requires-Dist: ipywidgets; extra == "dev"
 Requires-Dist: nbdev-numpy; extra == "dev"
@@ -43,20 +40,7 @@ Requires-Dist: pysymbol_llm; extra == "dev"
 Requires-Dist: llms-txt; extra == "dev"
 Requires-Dist: sphinx; extra == "dev"
 Requires-Dist: plum-dispatch; extra == "dev"
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: license
 Dynamic: license-file
-Dynamic: project-url
-Dynamic: provides-extra
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
 
 # Getting Started
 

{nbdev-2.4.13 → nbdev-3.0.0}/nbdev/__init__.py

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

{nbdev-2.4.13 → nbdev-3.0.0}/nbdev/_modidx.py

@@ -28,23 +28,31 @@ d = { 'settings': { 'branch': 'main',
                            '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'),
@@ -145,15 +153,20 @@ d = { 'settings': { 'branch': 'main',
                              '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'),
@@ -161,11 +174,13 @@ d = { 'settings': { 'branch': 'main',
                                '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'),
@@ -303,7 +318,6 @@ d = { 'settings': { 'branch': 'main',
                                '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-2.4.13 → nbdev-3.0.0}/nbdev/clean.py

@@ -125,8 +125,8 @@ def process_write(warn_msg, proc_nb, f_in, f_out=None, disp=False):
 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)
 

{nbdev-2.4.13 → nbdev-3.0.0}/nbdev/cli.py

@@ -65,7 +65,7 @@ def _render_nb(fn, cfg):
     "Render templated values like `{{lib_name}}` in notebook at `fn` from `cfg`"
     txt = fn.read_text()
     txt = txt.replace('from your_lib.core', f'from {cfg.lib_path}.core') # for compatibility with old templates
-    for k,v in cfg.d.items(): txt = txt.replace('{{'+k+'}}', v)
+    for k,v in cfg.items(): txt = txt.replace('{{'+k+'}}', str(v))
     fn.write_text(txt)
 
 # %% ../nbs/api/13_cli.ipynb #dd385911-aa8f-44e7-8d46-7b8a20f3b010
@@ -87,10 +87,11 @@ def nbdev_new(**kwargs):
     from ghapi.core import GhApi
     nbdev_create_config.__wrapped__(**kwargs)
     cfg = get_config()
-    _update_repo_meta(cfg)
+    if (Path('.git')).exists(): _update_repo_meta(cfg)
+    else: print(f"No git repo found. Run: gh repo create {cfg.user}/{cfg.repo} --public --source=.")
     path = Path()
 
-    _ORG_OR_USR,_REPOSITORY = 'answerdotai','nbdev-template'
+    _ORG_OR_USR,_REPOSITORY = 'answerdotai','nbdev3-template'
     _TEMPLATE = f'{_ORG_OR_USR}/{_REPOSITORY}'
     template = kwargs.get('template', _TEMPLATE)
     try: org_or_usr, repo = template.split('/')
@@ -143,24 +144,23 @@ def nbdev_update_license(
     avail_lic = GhApi().licenses.get_all_commonly_used().map(lambda x: x['key'])
 
     cfg = get_config()
-    curr_lic = cfg['license']
+    curr_lic = cfg.license
 
     mapped = mapping.get(to, None)
-
     if mapped not in avail_lic: raise ValueError(f"{to} is not an available license")
     body = GhApi().licenses.get(mapped)['body']
 
-    body = body.replace('[year], [fullname]', cfg['copyright'])
-    body = body.replace('[year] [fullname]', cfg['copyright'])
-
-    content = open("settings.ini", "r").read()
-    content = re.sub(r"^(license\s*=\s*).*?$", r"\1 " + to, content, flags=re.MULTILINE)
+    copyright = f"{datetime.now().year}, {cfg.author}"
+    body = body.replace('[year], [fullname]', copyright)
+    body = body.replace('[year] [fullname]', copyright)
 
-    config = open("settings.ini", "w")
-    config.write(content)
+    # Update pyproject.toml
+    pyproj = cfg.config_file
+    content = pyproj.read_text()
+    content = re.sub(r'^(license\s*=\s*\{text\s*=\s*").*?(")', rf'\g<1>{to}\2', content, flags=re.MULTILINE)
+    pyproj.write_text(content)
 
-    lic = open('LICENSE', 'w')
-    lic.write(body)
+    Path('LICENSE').write_text(body)
     print(f"License updated from {curr_lic} to {to}")
 
 # %% ../nbs/api/13_cli.ipynb #412b4cd2

nbdev-3.0.0/nbdev/config.py

@@ -0,0 +1,366 @@
+"""Configuring nbdev and bootstrapping notebook export"""
+
+# AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/01_config.ipynb.
+
+# %% auto #0
+__all__ = ['pyproject_nm', 'pyproject_tmpl', 'nbdev_defaults', 'pyproj_tmpl', 'nbdev_create_config', 'ConfigToml', 'get_config',
+           'is_nbdev', 'create_output', 'show_src', 'read_version', 'set_version', 'bump_version', 'update_version',
+           'update_proj', 'add_init', 'write_cells']
+
+# %% ../nbs/api/01_config.ipynb #6fd14ecd
+from datetime import datetime
+from fastcore.docments import *
+from fastcore.utils import *
+from fastcore.meta import *
+from fastcore.script import *
+from fastcore.style import *
+from fastcore.xdg import *
+
+import ast,warnings,tomli
+from IPython.display import Markdown
+from execnb.nbio import read_nb,NbCell
+from urllib.error import HTTPError
+
+# %% ../nbs/api/01_config.ipynb #117128e6
+pyproject_nm = 'pyproject.toml'
+_nbdev_home_dir = 'nbdev'
+_user_cfg_name = 'config.toml'
+
+# %% ../nbs/api/01_config.ipynb #adf0834f
+def _git_repo():
+    try: return repo_details(run('git config --get remote.origin.url'))[1]
+    except OSError: return
+
+# %% ../nbs/api/01_config.ipynb #6eeafafd
+def _get_info(owner, repo, default_branch='main', default_kw='nbdev'):
+    from ghapi.all import GhApi
+    api = GhApi(owner=owner, repo=repo, token=os.getenv('GITHUB_TOKEN'))
+    
+    try: r = api.repos.get()
+    except HTTPError:
+        msg= [f"""Could not access repo: {owner}/{repo} to find your default branch - `{default_branch}` assumed.
+Edit `pyproject.toml` if this is incorrect.
+In the future, you can allow nbdev to see private repos by setting the environment variable GITHUB_TOKEN as described here:
+https://nbdev.fast.ai/api/release.html#setup"""]
+        print(''.join(msg))
+        return default_branch,default_kw,''
+    
+    return r.default_branch, default_kw if not getattr(r, 'topics', []) else ' '.join(r.topics), r.description
+
+# %% ../nbs/api/01_config.ipynb #35d5c037
+def _fetch_from_git(raise_err=False):
+    "Get information for pyproject.toml from git."
+    res={}
+    try:
+        url = run('git config --get remote.origin.url')
+        res['user'],res['repo'] = repo_details(url)
+        res['branch'],res['keywords'],desc = _get_info(owner=res['user'], repo=res['repo'])
+        if desc: res['description'] = desc
+        res['author'] = run('git config --get user.name').strip()
+        res['author_email'] = run('git config --get user.email').strip()
+    except OSError as e:
+        if raise_err: raise(e)
+    else: res['lib_name'] = res['repo'].replace('-','_')
+    return res
+
+# %% ../nbs/api/01_config.ipynb #05aae09f
+pyproject_tmpl = '''[build-system]
+requires = ["setuptools>=64"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "{name}"
+dynamic = ["version"]
+description = "{description}"
+readme = "README.md"
+requires-python = ">={min_python}"
+license = {{text = "{license}"}}
+authors = [{{name = "{author}", email = "{author_email}"}}]
+keywords = {keywords}
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+]
+dependencies = []
+
+[project.urls]
+Repository = "{git_url}"
+Documentation = "{doc_url}"
+
+[project.entry-points.nbdev]
+{lib_path} = "{lib_path}._modidx:d"
+
+[tool.setuptools.dynamic]
+version = {{attr = "{lib_path}.__version__"}}
+
+[tool.setuptools.packages.find]
+include = ["{lib_path}"]
+
+[tool.nbdev]
+'''
+
+# %% ../nbs/api/01_config.ipynb #3fc5c33f
+@call_parse
+def nbdev_create_config(
+    repo:str=None, # Repo name
+    branch:str='main', # Repo default branch
+    user:str=None, # Repo username
+    author:str=None, # Package author's name
+    author_email:str=None, # Package author's email address
+    description:str='', # Short summary of the package
+    path:str='.', # Path to create config file
+    min_python:str='3.10', # Minimum Python version
+    license:str='Apache-2.0', # License (SPDX identifier)
+):
+    "Create a pyproject.toml config file."
+    path = Path(path)
+    path.mkdir(exist_ok=True, parents=True)
+    
+    # Infer from git if not provided
+    inf = _fetch_from_git()
+    repo = repo or inf.get('repo') or path.resolve().name
+    user = user or inf.get('user', '')
+    if not user: raise ValueError("Could not infer `user` from git. Please pass --user explicitly.")
+    author = author or inf.get('author', '')
+    if not author: raise ValueError("Could not infer `author` from git. Please pass --author explicitly.")
+    author_email = author_email or inf.get('author_email', '')
+    if not author_email: raise ValueError("Could not infer `author_email` from git. Please pass --author_email explicitly.")
+    branch = branch or inf.get('branch', 'main')
+    description = description or inf.get('description', '')
+    
+    lib_path = repo.replace('-', '_')
+    git_url = f"https://github.com/{user}/{repo}" if user else ''
+    doc_url = f"https://{user}.github.io/{repo}/" if user else ''
+    keywords = inf.get('keywords', 'nbdev').split()
+    
+    txt = pyproject_tmpl.format(name=repo, lib_path=lib_path, description=description, min_python=min_python, license=license,
+        author=author, author_email=author_email, keywords=keywords, git_url=git_url, doc_url=doc_url, branch=branch)
+    
+    cfg_file = path / pyproject_nm
+    if cfg_file.exists(): warn(f'{cfg_file} already exists')
+    else:
+        cfg_file.write_text(txt)
+        print(f'{cfg_file} created.')
+
+# %% ../nbs/api/01_config.ipynb #0e56064f
+def _load_toml(p):
+    "Load TOML file at `p` into a dict"
+    return tomli.loads(Path(p).read_text(encoding='utf-8'))
+
+def _has_nbdev(p):
+    "True if pyproject.toml at `p` has [tool.nbdev]"
+    try: return bool(_load_toml(p).get('tool', {}).get('nbdev', {}))
+    except Exception: return False
+
+def _find_nbdev_pyproject(path=None):
+    "Find nearest pyproject.toml containing [tool.nbdev], walking up from `path`"
+    p = Path(path or Path.cwd()).resolve()
+    for d in [p] + list(p.parents):
+        f = d/pyproject_nm
+        if f.exists() and _has_nbdev(f): return f
+
+# %% ../nbs/api/01_config.ipynb #3dac70e0
+nbdev_defaults = dict(nbs_path='nbs', doc_path='_docs', tst_flags='notest', recursive=True, readme_nb='index.ipynb',
+    clean_ids=True, clear_all=False, put_version_in_init=True, jupyter_hooks=False, black_formatting=False, branch='main')
+
+_path_keys = 'lib_path', 'nbs_path', 'doc_path'
+
+# %% ../nbs/api/01_config.ipynb #165ff301
+class ConfigToml(AttrDict):
+    def __init__(self, d, proj, cfg_file):
+        super().__init__({**nbdev_defaults, **d})
+        self.config_file = cfg_file
+        self.config_path = cfg_file.parent
+        
+        self.lib_name = proj.get('name', '')
+        self.title = self.get('title') or self.lib_name
+        self.description = proj.get('description', '')
+        self.keywords = proj.get('keywords', [])
+        self.min_python = (proj.get('requires-python') or '>=3.9').lstrip('>=')
+        auths = proj.get('authors') or [{}]
+        self.author = auths[0].get('name')
+        self.author_email = auths[0].get('email')
+        
+        
+        urls = proj.get('urls') or {}
+        self.git_url = (urls.get('Repository') or urls.get('Source') or '').rstrip('/')
+        self.doc_url = urls.get('Documentation') or ''
+        self.user, self.repo = repo_details(self.git_url) if self.git_url else ('', '')
+        # Derive doc_host and doc_baseurl from doc_url
+        from urllib.parse import urlparse
+        u = urlparse(self.doc_url)
+        self.doc_host = f"{u.scheme}://{u.netloc}" if u.scheme else ''
+        self.doc_baseurl = (u.path or '/').rstrip('/') or '/'
+        if 'lib_path' not in self: self['lib_path'] = self.lib_name.replace('-', '_')
+
+    @property
+    def version(self):
+        return read_version(self.config_path / self['lib_path']) or '0.0.1'
+
+    @property
+    def d(self): return {k:v for k,v in super().items()}
+
+    def __getattr__(self, k): return stop(AttributeError(k)) if k=='d' or k not in self.d else self.get(k)
+    def __getitem__(self, k): return stop(IndexError(k)) if k not in self.d else self.get(k)
+
+    def get(self, k, default=None):
+        v = self.d.get(k, default)
+        if v is None: return None
+        return self.config_path / v if k in _path_keys else v
+
+    def path(self, k, default=None):
+        v = self.d.get(k, default)
+        return v if v is None else self.config_path / v
+
+# %% ../nbs/api/01_config.ipynb #6fed9c91
+def _user_config():
+    "Load user config from ~/.config/nbdev/config.toml if it exists"
+    p = xdg_config_home() / _nbdev_home_dir / _user_cfg_name
+    if p.exists(): return _load_toml(p)
+    return {}
+
+# %% ../nbs/api/01_config.ipynb #f6660849
+def get_config(path=None, also_settings=False):
+    "Return nbdev config."
+    cfg_file = _find_nbdev_pyproject(path)
+    if cfg_file is not None:
+        # Check for old settings.ini and complain loudly
+        old_cfg = cfg_file.parent / 'settings.ini'
+        if old_cfg.exists() and not also_settings:
+            raise ValueError(f"Found old settings.ini at {old_cfg}. Please migrate to pyproject.toml using `nbdev_migrate`. See https://nbdev.fast.ai/getting_started.html for details.")
+        d = _load_toml(cfg_file)
+        user = _user_config()
+        nbdev = {**user, **d.get('tool', {}).get('nbdev', {})}
+        return ConfigToml(nbdev, d.get('project', {}), cfg_file)
+    if also_settings:
+        from fastcore.foundation import Config
+        cfg = Config.find('settings.ini', path)
+        if cfg: return cfg
+    cfg_path = Path(path or Path.cwd()).expanduser().absolute()
+    return ConfigToml(nbdev_defaults, {}, cfg_path/'pyproject.toml')
+
+# %% ../nbs/api/01_config.ipynb #6939b40e
+def is_nbdev(path=None): return _find_nbdev_pyproject(path) is not None
+
+# %% ../nbs/api/01_config.ipynb #6e89fe6c
+def create_output(txt, mime):
+    "Add a cell output containing `txt` of the `mime` text MIME sub-type"
+    return [dict(data={f"text/{mime}": str(txt).splitlines(True)},
+                 execution_count=1, metadata={}, output_type="execute_result")]
+
+# %% ../nbs/api/01_config.ipynb #5a4d8e52
+def show_src(src, lang='python'): return Markdown(f'```{lang}\n{src}\n```')
+
+# %% ../nbs/api/01_config.ipynb #163177f2
+pyproj_tmpl = """[build-system]
+requires = ["setuptools>=64.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "FILL_IN"
+requires-python="FILL_IN"
+dynamic = [ "keywords", "description", "version", "dependencies", "optional-dependencies", "readme",
+    "license", "authors", "classifiers", "entry-points", "scripts", "urls"]
+
+[tool.uv]
+cache-keys = [{ file = "pyproject.toml" }, { file = "setup.py" }]
+"""
+
+# %% ../nbs/api/01_config.ipynb #f1c85f45
+_re_version = re.compile(r'^__version__\s*=\s*[\'"]([^\'"]+)[\'"]', re.MULTILINE)
+_re_proj = re.compile(r'^name\s*=\s*".*$', re.MULTILINE)
+_re_reqpy = re.compile(r'^requires-python\s*=\s*".*$', re.MULTILINE)
+_init = '__init__.py'
+_pyproj = 'pyproject.toml'
+
+# %% ../nbs/api/01_config.ipynb #680e62a5
+def read_version(path):
+    "Read __version__ from `path/__init__.py`, or None if not found"
+    fname = Path(path)/_init
+    if not fname.exists(): return None
+    m = _re_version.search(fname.read_text())
+    return m.group(1) if m else None
+
+# %% ../nbs/api/01_config.ipynb #cf0fc6a3
+def set_version(path, version):
+    "Set __version__ in `path/__init__.py`"
+    path = Path(path)
+    path.mkdir(exist_ok=True, parents=True)
+    fname = path/_init
+    if not fname.exists(): fname.touch()
+    ver_line = f'__version__ = "{version}"'
+    code = fname.read_text()
+    if _re_version.search(code) is None: code = ver_line + "\n" + code
+    else: code = _re_version.sub(ver_line, code)
+    fname.write_text(code)
+
+# %% ../nbs/api/01_config.ipynb #d00889e5
+def bump_version(v, part=2, unbump=False):
+    "Bump semver string `v` at index `part` (0=major, 1=minor, 2=patch)"
+    parts = (v or '0.0.0').split('.')
+    parts += ['0'] * (3 - len(parts))
+    parts[part] = str(int(parts[part]) + (-1 if unbump else 1))
+    for i in range(part+1, 3): parts[i] = '0'
+    return '.'.join(parts[:3])
+
+# %% ../nbs/api/01_config.ipynb #e32583e6
+def update_version(path=None):
+    "Add __version__ to `path/__init__.py` if it doesn't exist"
+    path = Path(path or get_config().lib_path)
+    if read_version(path) is None: set_version(path, get_config().version)
+
+# %% ../nbs/api/01_config.ipynb #275ef862
+def _has_py(fs): return any(1 for f in fs if f.endswith('.py'))
+
+def update_proj(path):
+    "Create or update `pyproject.toml` in the project root."
+    fname = path/_pyproj
+    if not fname.exists(): fname.write_text(pyproj_tmpl)
+    txt = fname.read_text()
+    txt = _re_proj.sub(f'name = "{get_config().lib_name}"', txt)
+    txt = _re_reqpy.sub(f'requires-python = ">={get_config().min_python}"', txt)
+    fname.write_text(txt)
+
+# %% ../nbs/api/01_config.ipynb #bdf57184
+def add_init(path=None):
+    "Add `__init__.py` in all subdirs of `path` containing python files if it's not there already."
+    # we add the lowest-level `__init__.py` files first, which ensures _has_py succeeds for parent modules
+    path = Path(path or get_config().lib_path)
+    path.mkdir(exist_ok=True)
+    if not (path/_init).exists(): (path/_init).touch()
+    for r,ds,fs in os.walk(path, topdown=False):
+        r = Path(r)
+        subds = (os.listdir(r/d) for d in ds)
+        if _has_py(fs) or any(filter(_has_py, subds)) and not (r/_init).exists(): (r/_init).touch()
+    if get_config().get('put_version_in_init', True): update_version(path)
+    if get_config().get('update_pyproject', True): update_proj(path.parent)
+
+# %% ../nbs/api/01_config.ipynb #cdd05b4c
+def write_cells(cells, hdr, file, solo_nb=False):
+    "Write `cells` to `file` along with header `hdr` (mainly for nbdev internal use)."
+    for cell in cells:
+        if cell.cell_type=='code' and cell.source.strip():
+            cell_id = f" #{cell.id}" if cell.get('id') else ""
+            file.write(f'\n\n{hdr}{cell_id}\n{cell.source}') if not solo_nb else file.write(f'\n\n{cell.source}')
+
+# %% ../nbs/api/01_config.ipynb #34cfeb82
+def _basic_export_nb(fname, name, dest=None):
+    "Basic exporter to bootstrap nbdev."
+    if dest is None: dest = get_config().lib_path
+    add_init()
+    fname,dest = Path(fname),Path(dest)
+    nb = read_nb(fname)
+
+    # grab the source from all the cells that have an `export` comment
+    cells = L(cell for cell in nb.cells if re.match(r'#\s*\|export', cell.source))
+
+    # find all the exported functions, to create `__all__`:
+    trees = cells.map(NbCell.parsed_).concat()
+    funcs = trees.filter(risinstance((ast.FunctionDef,ast.ClassDef))).attrgot('name')
+    exp_funcs = [f for f in funcs if f[0]!='_']
+
+    # write out the file
+    with (dest/name).open('w',encoding="utf-8") as f:
+        f.write(f"# %% auto 0\n__all__ = {exp_funcs}")
+        write_cells(cells, f"# %% {fname.relpath(dest)}", f)
+        f.write('\n')

{nbdev-2.4.13 → nbdev-3.0.0}/nbdev/doclinks.py

@@ -107,8 +107,7 @@ def _build_modidx(dest=None, nbs_path=None, skip_exists=False):
     with contextlib.suppress(FileNotFoundError): idxfile.unlink()
     if idxfile.exists(): res = exec_local(idxfile.read_text(encoding='utf-8'), 'd')
     else: res = dict(syms={}, settings={}) 
-    res['settings'] = {k:v for k,v in get_config().d.items()
-                       if k in ('doc_host','doc_baseurl','lib_path','git_url','branch')}
+    res['settings'] = {k:v for k,v in get_config().d.items() if k in ('doc_host','doc_baseurl','lib_path','git_url','branch')}
     code_root = dest.parent.resolve()
     for file in globtastic(dest, file_glob="*.py", skip_file_re='^_', skip_folder_re=r"\.ipynb_checkpoints"):
         try: res['syms'].update(_get_modidx((dest.parent/file).resolve(), code_root, nbs_path=nbs_path))
@@ -229,12 +228,12 @@ _re_backticks = re.compile(r'`([^`\s]+?)(?:\(\))?`')
 # %% ../nbs/api/05_doclinks.ipynb #3a24b883
 @lru_cache(None)
 def _build_lookup_table(strip_libs=None, incl_libs=None, skip_mods=None):
-    cfg = get_config()
+    cfg = get_config(also_settings=True)
     if strip_libs is None:
-        try: strip_libs = cfg.get('strip_libs', cfg.get('lib_path', 'nbdev').name).split()
+        try: strip_libs = cfg.get('strip_libs') or cfg.lib_name
         except FileNotFoundError: strip_libs = 'nbdev'
     skip_mods = setify(skip_mods)
-    strip_libs = L(strip_libs)
+    strip_libs = L(strip_libs.split() if isinstance(strip_libs, str) else strip_libs)
     if incl_libs is not None: incl_libs = (L(incl_libs)+strip_libs).unique()
     entries = {}
     try: eps = entry_points(group='nbdev')

{nbdev-2.4.13 → nbdev-3.0.0}/nbdev/export.py

@@ -35,10 +35,9 @@ class ExportModuleProc:
 
 # %% ../nbs/api/04_export.ipynb #6f524839
 def black_format(cell, # Cell to format
-                 force=False): # Turn black formatting on regardless of settings.ini
+                 force=False): # Turn black formatting on regardless of pyproject.toml
     "Processor to format code with `black`"
-    try: cfg = get_config()
-    except FileNotFoundError: return
+    cfg = get_config()
     if (not cfg.black_formatting and not force) or cell.cell_type != 'code': return
     try: import black
     except: raise ImportError("You must install black: `pip install black` if you wish to use black formatting with nbdev")
@@ -53,8 +52,7 @@ _magics_pattern = re.compile(r'^\s*(%%|%).*\n?', re.MULTILINE)
 
 def scrub_magics(cell): # Cell to format
     "Processor to remove cell magics from exported code"
-    try: cfg = get_config()
-    except FileNotFoundError: return
+    cfg = get_config()
     if cell.cell_type != 'code': return
     try: cell.source = _magics_pattern.sub('', cell.source)
     except: pass