nbdev 2.3.13__py3-none-any.whl → 2.3.14__py3-none-any.whl

nbdev/__init__.py

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

nbdev/_modidx.py

@@ -24,7 +24,8 @@ d = { 'settings': { 'branch': 'master',
                            'nbdev.cli.chelp': ('api/cli.html#chelp', 'nbdev/cli.py'),
                            'nbdev.cli.extract_tgz': ('api/cli.html#extract_tgz', '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_new': ('api/cli.html#nbdev_new', 'nbdev/cli.py'),
+                           'nbdev.cli.nbdev_update_license': ('api/cli.html#nbdev_update_license', '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'),

nbdev/cli.py

@@ -25,7 +25,7 @@ from contextlib import redirect_stdout
 import os, tarfile, sys
 
 # %% auto 0
-__all__ = ['nbdev_filter', 'extract_tgz', 'nbdev_new', 'chelp']
+__all__ = ['mapping', 'nbdev_filter', 'extract_tgz', 'nbdev_new', 'nbdev_update_license', 'chelp']
 
 # %% ../nbs/api/13_cli.ipynb 5
 @call_parse
@@ -67,7 +67,7 @@ def _render_nb(fn, cfg):
 def _update_repo_meta(cfg):
     "Enable gh pages and update the homepage and description in your GitHub repo."
     token=os.getenv('GITHUB_TOKEN')
-    if token: 
+    if token:
         from ghapi.core import GhApi
         api = GhApi(owner=cfg.user, repo=cfg.repo, token=token)
         try: api.repos.update(homepage=f'{cfg.doc_host}{cfg.doc_baseurl}', description=cfg.description)
@@ -85,13 +85,28 @@ def nbdev_new(**kwargs):
     _update_repo_meta(cfg)
 
     path = Path()
-    with warnings.catch_warnings():
-        warnings.simplefilter('ignore', UserWarning)
-        tag = GhApi(gh_host='https://api.github.com', authenticate=False).repos.get_latest_release('fastai', 'nbdev-template').tag_name
-    url = f"https://github.com/fastai/nbdev-template/archive/{tag}.tar.gz"
-    extract_tgz(url)
-    tmpl_path = path/f'nbdev-template-{tag}'
 
+    _ORG_OR_USR = 'fastai'
+    _REPOSITORY = 'nbdev-template'
+    _TEMPLATE = f'{_ORG_OR_USR}/{_TEMPLATE}'
+    template = kwargs.get('template', _TEMPLATE)
+    try:
+        org_or_usr, repo = template.split('/')
+    except ValueError:
+        org_or_usr, repo = _ORG_OR_USR, _REPOSITORY
+
+
+    tag = kwargs.get('tag', None)
+    if tag is None:
+        with warnings.catch_warnings():
+            warnings.simplefilter('ignore', UserWarning)
+
+            tag = GhApi(gh_host='https://api.github.com', authenticate=False).repos.get_latest_release(org_or_usr, repo).tag_name
+
+    url = f"https://github.com/{org_or_usr}/{repo}/archive/{tag}.tar.gz"
+    extract_tgz(url)
+    tmpl_path = path/f'{repo}-{tag}'
+    
     cfg.nbs_path.mkdir(exist_ok=True)
     nbexists = bool(first(cfg.nbs_path.glob('*.ipynb')))
     _nbs_path_sufs = ('.ipynb','.css')
@@ -108,7 +123,47 @@ def nbdev_new(**kwargs):
     nbdev_export.__wrapped__()
     nbdev_readme.__wrapped__()
 
-# %% ../nbs/api/13_cli.ipynb 15
+# %% ../nbs/api/13_cli.ipynb 13
+mapping = {
+  'mit': 'mit',
+  'apache2': 'apache-2.0',
+  'gpl2': 'gpl-2.0',
+  'gpl3': 'gpl-3.0',
+  'bsd3': 'bsd-3-clause'
+}
+
+# %% ../nbs/api/13_cli.ipynb 14
+@call_parse
+def nbdev_update_license(
+    to: str=None, # update license to
+):
+    "Allows you to update the license of your project."
+    from ghapi.core import GhApi
+    warnings.filterwarnings("ignore")
+    avail_lic = GhApi().licenses.get_all_commonly_used().map(lambda x: x['key'])
+
+    cfg = get_config()
+    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)
+
+    config = open("settings.ini", "w")
+    config.write(content)
+
+    lic = open('LICENSE', 'w')
+    lic.write(body)
+    print(f"License updated from {curr_lic} to {to}")
+
+# %% ../nbs/api/13_cli.ipynb 17
 @call_parse
 def chelp():
     "Show help for all console scripts"

nbdev/config.py

@@ -152,6 +152,8 @@ _nbdev_cfg_tail = '''### Optional ###
 # requirements = fastcore pandas
 # dev_requirements = 
 # console_scripts =
+# conda_user = 
+# package_data = 
 '''
 
 # %% ../nbs/api/01_config.ipynb 21

nbdev/quarto.py

@@ -3,7 +3,7 @@
 # %% ../nbs/api/14_quarto.ipynb 3
 from __future__ import annotations
 import subprocess,sys,shutil,ast,warnings,traceback
-from os import system, uname
+from os import system
 from contextlib import contextmanager
 
 from .config import *
@@ -30,6 +30,7 @@ def _sprun(cmd):
 BASE_QUARTO_URL='https://www.quarto.org/download/latest/'
 
 def _install_linux():
+    from os import uname
     machine = 'arm' if uname().machine in ('arm64', 'aarch64', 'armv8', 'armv8l') else 'amd'
     system(f'curl -LO {BASE_QUARTO_URL}quarto-linux-{machine}64.deb')
     system(f'sudo dpkg -i quarto-linux-{machine}64.deb && rm quarto-linux-{machine}64.deb')
@@ -251,6 +252,7 @@ def _save_cached_readme(cache, cfg):
 def nbdev_readme(
     path:str=None, # Path to notebooks
     chk_time:bool=False): # Only build if out of date
+    "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
@@ -309,6 +311,7 @@ def nbdev_preview(
     path:str=None, # Path to notebooks
     port:int=None, # The port on which to run preview
     host:str=None, # The host on which to run preview
+    no_browser:bool=False, # Do not open a browser
     n_workers:int=defaults.cpus,  # Number of workers
     **kwargs):
     "Preview docs locally"
@@ -317,6 +320,7 @@ def nbdev_preview(
     xtra = []
     if port: xtra += ['--port', str(port)]
     if host: xtra += ['--host', host]
+    if no_browser: xtra += ['--no-browser']
 
     def _f(e):
         res = _proc_file(Path(e.src_path), cache, path)

nbdev/release.py

@@ -201,8 +201,9 @@ def _get_conda_meta():
     doc_url = (cfg.doc_host + cfg.doc_baseurl) if (cfg.doc_host and cfg.doc_baseurl) else url
     dev_url = cfg.git_url if cfg.git_url else url
 
-    hostreqs = ['pip', 'packaging', f'python >={cfg.min_python}']
-    if cfg.get('requirements'): reqs = hostreqs[-1:] + cfg.requirements.split()
+    hostreqs = ['packaging', f'python >={cfg.min_python}']
+    reqs = hostreqs+[]
+    if cfg.get('requirements'): reqs += cfg.requirements.split()
     if cfg.get('conda_requirements'): reqs += cfg.conda_requirements.split()
 
     pypi = pypi_json(f'{name}/{ver}')

nbdev/serve.py

@@ -62,15 +62,15 @@ def proc_nbs(
     cfg = get_config()
     cache = cfg.config_path/'_proc'
     path = Path(path or cfg.nbs_path)
-    files = nbglob(path, func=Path, file_glob='', file_re='', **kwargs)
+    files = nbglob(path, func=Path, file_glob=file_glob, file_re=file_re, **kwargs)
     if (path/'_quarto.yml').exists(): files.append(path/'_quarto.yml')
-    if (path/'_extensions').exists(): files.extend(nbglob(path/'_extensions', func=Path, file_glob='', file_re='', skip_file_re='^[.]'))
+    if (path/'_extensions').exists(): files.extend(nbglob(path/'_extensions', func=Path, file_glob=file_glob, file_re=file_re, skip_file_re='^[.]'))
 
     # If settings.ini or filter script newer than cache folder modified, delete cache
     chk_mtime = max(cfg.config_file.stat().st_mtime, Path(__file__).stat().st_mtime)
     cache.mkdir(parents=True, exist_ok=True)
     cache_mtime = cache.stat().st_mtime
-    if force or (cache.exists and cache_mtime<chk_mtime): rmtree(cache)
+    if force or (cache.exists() and cache_mtime<chk_mtime): rmtree(cache)
 
     files = files.map(_proc_file, mtime=cache_mtime, cache=cache, path=path).filter()
     kw = {} if IN_NOTEBOOK else {'method':'spawn'}

nbdev/showdoc.py

@@ -171,7 +171,7 @@ class BasicMarkdownRenderer(ShowDocRenderer):
         doc += f'{h} {self.nm}\n\n'
         sig = _wrap_sig(f"{self.nm} {_fmt_sig(self.sig)}") if self.sig else ''
         doc += f'{sig}'
-        if self.docs: doc += f"\n\n{self.docs}"
+        if self.docs: doc += f"\n\n*{self.docs}*"
         if self.dm.has_docment: doc += f"\n\n{self.dm}"
         return doc
     __repr__=__str__=_repr_markdown_
@@ -199,7 +199,7 @@ class BasicHtmlRenderer(ShowDocRenderer):
         doc = '<hr/>\n'
         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>{self.docs}</p>"
+        if self.docs: doc += f"<p><i>{self.docs}</i></p>"
         return doc
 
     def doc(self):

{nbdev-2.3.13.dist-info → nbdev-2.3.14.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nbdev
-Version: 2.3.13
+Version: 2.3.14
 Summary: Create delightful software with Jupyter Notebooks
 Home-page: https://github.com/fastai/nbdev
 Author: Jeremy Howard and Hamel Husain
@@ -20,6 +20,7 @@ Classifier: License :: OSI Approved :: Apache Software License
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: packaging
 Requires-Dist: ipywidgets <=8.0.4
 Requires-Dist: fastcore >=1.5.27
 Requires-Dist: execnb >=0.1.4
@@ -43,15 +44,6 @@ Requires-Dist: jupyter ; extra == 'dev'
 
 ![CI](https://github.com/fastai/nbdev/actions/workflows/test.yaml/badge.svg)
 
-*NB: This is nbdev v2, a major upgrade of nbdev. Whilst the differences
-to nbdev1 aren’t huge, it does require some changes. The old version
-docs are at [nbdev1.fast.ai](https://nbdev1.fast.ai). You can use
-version-pinning in `settings.ini` (i.e `'nbdev<2'`) to stop nbdev from
-upgrading. To upgrade, follow the [migration
-tutorial](https://nbdev.fast.ai/migrating.html).*
-
-------------------------------------------------------------------------
-
 `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!
@@ -130,35 +122,34 @@ available commands:
 !nbdev_help
 ```
 
-    nbdev_bump_version              Increment version in settings.ini 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_deploy                    Deploy docs to GitHub Pages
-    nbdev_docs                      Create Quarto docs and README.md
-    nbdev_export                    Export notebooks in `path` to Python modules
-    nbdev_filter                    A notebook filter for Quarto
-    nbdev_fix                       Create working notebook from conflicted notebook `nbname`
-    nbdev_help                      Show help for all console scripts
-    nbdev_install                   Install Quarto and the current library
-    nbdev_install_hooks             Install Jupyter and git hooks to automatically clean, trust, and fix merge conflicts in notebooks
-    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 directives and callouts in `fname` from v1 to v2
-    nbdev_new                       Create an nbdev project.
-    nbdev_prepare                   Export, test, and clean notebooks, and render README if needed
-    nbdev_preview                   Preview docs locally
-    nbdev_proc_nbs                  Process notebooks in `path` for docs rendering
-    nbdev_pypi                      Create and upload Python package to PyPI
-    nbdev_readme                    None
-    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_sidebar                   Create sidebar.yml
-    nbdev_test                      Test in parallel notebooks matching `path`, passing along `flags`
-    nbdev_trust                     Trust notebooks matching `fname`
-    nbdev_update                    Propagate change in modules matching `fname` to notebooks that created them
+    nbdev_bump_version        Increment version in settings.ini 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_docs                Create Quarto docs and README.md
+    nbdev_export              Export notebooks in `path` to Python modules
+    nbdev_filter              A notebook filter for Quarto
+    nbdev_fix                 Create working notebook from conflicted notebook `nbname`
+    nbdev_help                Show help for all console scripts
+    nbdev_install             Install Quarto and the current library
+    nbdev_install_hooks       Install Jupyter and git hooks to automatically clean, trust, and fix merge conflicts in notebooks
+    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_new                 Create an nbdev project.
+    nbdev_prepare             Export, test, and clean notebooks, and render README if needed
+    nbdev_preview             Preview docs locally
+    nbdev_proc_nbs            Process notebooks in `path` for docs rendering
+    nbdev_pypi                Create and upload Python package to PyPI
+    nbdev_readme              Create README.md from readme_nb (index.ipynb by default)
+    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_sidebar             Create sidebar.yml
+    nbdev_test                Test in parallel notebooks matching `path`, passing along `flags`
+    nbdev_trust               Trust notebooks matching `fname`
+    nbdev_update              Propagate change in modules matching `fname` to notebooks that created them
 
 ## FAQ
 

{nbdev-2.3.13.dist-info → nbdev-2.3.14.dist-info}/RECORD

@@ -1,8 +1,8 @@
-nbdev/__init__.py,sha256=4UhIM685QoeA-8D5RM1qNrEV6avuYyepCItH7GFuNLs,90
-nbdev/_modidx.py,sha256=AAK8lG1cg1H86wspQV02f9jBBZuLumpFdjBu4vP-Mas,39593
+nbdev/__init__.py,sha256=Lvc7TM66PIvnPiPsx8AcP4Y5wo23vGqy1GYdDnNAzZY,90
+nbdev/_modidx.py,sha256=TdX0nyg7miq1j7D_LN99_kAmqQJEbrrlIJ7XBM1PDHs,39709
 nbdev/clean.py,sha256=lLtfhCLjkDBqf8MvIG9lDSWSmA9vUDvn2QhS6LPprHI,9284
-nbdev/cli.py,sha256=4edu0A4BH6UYEluGpUWx-8JSXbJyTXpRirGNMTxCLj8,4122
-nbdev/config.py,sha256=BMmNJKowvJu_HH2DsP2B6eCx6f0Tuaxmc4rrq6g-mQQ,12201
+nbdev/cli.py,sha256=nn9UxmpJaA_NorxDwP6jlFl5XnmWQdFqJHt0XAaKfbM,5637
+nbdev/config.py,sha256=fTTtYCQHyp8sXCFAyGN93eLOr3N3uOkv4LJ5-9Bclxs,12235
 nbdev/doclinks.py,sha256=X5d8Xz52p-LlWwhhCN6d-00RQ0E8BsONuPH_xUSA6kc,10287
 nbdev/export.py,sha256=LEhn7UpfMSm9QKrC31q91Bsw-ZHd68DNv7MjhsNi15A,3275
 nbdev/extract_attachments.py,sha256=O4mS4EFIOXL_yQ3jmsnBStrWxGR_nPNvxLYXHtLeimw,2208
@@ -14,16 +14,16 @@ nbdev/migrate.py,sha256=l2hO2Ymkjm1C3_JmFDsM-DN6bxgFeLjj-pBr1xNqunI,7317
 nbdev/process.py,sha256=7dl9U7JLL9wbJta-KKTTnkMktBVsK5s-y8OBxtfk68I,5863
 nbdev/processors.py,sha256=GyF0UAb9SQ9KEzqPF-iK9-FOtFzcUJENI8pY3sRhLcg,10048
 nbdev/qmd.py,sha256=3Cskd8ynm25Hh7bo-_t0hxCMF6jqXxgq_VfkpLBKu_w,2958
-nbdev/quarto.py,sha256=XMpOomIWplzrnV8VHkysEXq2ZmXINGQFkvJh_F4jMYo,11841
-nbdev/release.py,sha256=O6gas0-hQOAqgBA64uVfGMAXfIcvyJlcrK_kJgtYjOU,14228
-nbdev/serve.py,sha256=LCamfb7U4HONcVVWKA1j_EvhvuLj4OlCiZiESdNyO0o,3018
+nbdev/quarto.py,sha256=uPburjx-OG9ruNTI08Ku_iOV5gerUUGNQUXDeOGmAco,12017
+nbdev/release.py,sha256=1rqBx77XPWSfb9JW8X7rTyaHz7wc4aRd3BHIkJafcKI,14229
+nbdev/serve.py,sha256=7Gpu8tQGrHzNW4UJO-xz6AWQo7xKTWxXOOsHq606M58,3044
 nbdev/serve_drv.py,sha256=IZ2acem_KKsXYYe0iUECiR_orkYLBkT1ZG_258ZS7SQ,657
-nbdev/showdoc.py,sha256=YY7Mv3HWW_ymBMe7yNqC7dHem6vbthWE286IDDCdhPo,9141
+nbdev/showdoc.py,sha256=sWkpTLpWLUMQBsysHqyvS7czIVcmfkJ_pjSU3zcp-AI,9150
 nbdev/sync.py,sha256=ZKcWRJd49EaYJXeIB8hSa8oWHDrqRWoyRbGUGHDYxJg,2898
 nbdev/test.py,sha256=74db-sK_rnc69Q3beztibXDSZUeOk6M9nIiIORLHzlo,4397
-nbdev-2.3.13.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-nbdev-2.3.13.dist-info/METADATA,sha256=kAJCCcHYLFOkClrCgAuYpnX4NKA5R5cJIc4k2h8r3Jg,10763
-nbdev-2.3.13.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-nbdev-2.3.13.dist-info/entry_points.txt,sha256=9zzSNu4DhySbWrGiPvj6ZTk5N2fsBYktgkswJDHMCLM,1218
-nbdev-2.3.13.dist-info/top_level.txt,sha256=3cWYLMuaXsZjz3TQRGEkWGs9Z8ieEDmYcq8TZS3y3vU,6
-nbdev-2.3.13.dist-info/RECORD,,
+nbdev-2.3.14.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+nbdev-2.3.14.dist-info/METADATA,sha256=esMAIjRT278jcHcSxvuv-lJyTkUhsDz9O57vHJ7GfV4,10161
+nbdev-2.3.14.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
+nbdev-2.3.14.dist-info/entry_points.txt,sha256=lFZD1JQyZQI8x8PuaaSqbfnhInHhpm56nCR6n84nFKk,1272
+nbdev-2.3.14.dist-info/top_level.txt,sha256=3cWYLMuaXsZjz3TQRGEkWGs9Z8ieEDmYcq8TZS3y3vU,6
+nbdev-2.3.14.dist-info/RECORD,,

{nbdev-2.3.13.dist-info → nbdev-2.3.14.dist-info}/entry_points.txt

@@ -27,6 +27,7 @@ nbdev_sidebar = nbdev.quarto:nbdev_sidebar
 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
 
 [nbdev]
 nbdev = nbdev._modidx:d