fixes #1515

Author: jph00

nbdev/__init__.py

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

nbdev/_modidx.py

@@ -46,6 +46,7 @@
                               '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_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.doclinks': { 'nbdev.doclinks.NbdevLookup': ('api/doclinks.html#nbdevlookup', 'nbdev/doclinks.py'),

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', 'is_nbdev', 'create_output', 'show_src', 'update_version',
-           'add_init', 'write_cells']
+__all__ = ['pyproj_tmpl', 'nbdev_create_config', 'get_config', 'config_key', 'is_nbdev', 'create_output', 'show_src',
+           'update_version', 'update_proj', 'add_init', 'write_cells']
 
 # %% ../nbs/api/01_config.ipynb
 from datetime import datetime
@@ -49,7 +49,7 @@ def _apply_defaults(
     license='apache2', # License for the package
     copyright:str=None, # Copyright for the package, defaults to '`current_year` onwards, `author`'
     status='3', # Development status PyPI classifier
-    min_python='3.7', # Minimum Python version PyPI classifier
+    min_python='3.9', # Minimum Python version PyPI classifier
     audience='Developers', # Intended audience PyPI classifier
     language='English', # Language PyPI classifier
     recursive:bool_arg=True, # Include subfolders in notebook globs?
@@ -63,6 +63,7 @@ def _apply_defaults(
     clear_all:bool_arg=False, # Remove all cell metadata and cell outputs?
     cell_number:bool_arg=True, # Add cell number to the exported file
     put_version_in_init:bool_arg=True, # Add the version to the main __init__.py in nbdev_export
+    update_pyproject:bool_arg=True, # Create/update pyproject.toml with correct project name
     skip_procs:str='', # A comma-separated list of processors that you want to skip
 ):
     "Apply default settings where missing in `cfg`."
@@ -142,7 +143,7 @@ def _cfg2txt(cfg, head, sections, tail=''):
 
 '''
 _nbdev_cfg_sections = {'Python library': 'repo lib_name version min_python license black_formatting',
-                       'nbdev': 'doc_path lib_path nbs_path recursive tst_flags put_version_in_init',
+                       'nbdev': 'doc_path lib_path nbs_path recursive tst_flags put_version_in_init update_pyproject',
                        'Docs': 'branch custom_sidebar doc_host doc_baseurl git_url title',
                        'PyPI': 'audience author author_email copyright description keywords language status user'}
 _nbdev_cfg_tail = '''### Optional ###
@@ -219,9 +220,26 @@ def create_output(txt, mime):
 # %% ../nbs/api/01_config.ipynb
 def show_src(src, lang='python'): return Markdown(f'```{lang}\n{src}\n```')
 
+# %% ../nbs/api/01_config.ipynb
+pyproj_tmpl = """[build-system]
+requires = ["setuptools>=64.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "FILL_IN"
+requires-python="FILL_IN"
+dynamic = ["description", "version","dependencies", "optional-dependencies", "readme", "requires-python", "license", "authors", "keywords", "classifiers", "entry-points", "urls"]
+
+[tool.uv]
+cache-keys = [{ file = "pyproject.toml" }, { file = "settings.ini" }, { file = "setup.py" }]
+"""
+
 # %% ../nbs/api/01_config.ipynb
 _re_version = re.compile(r'^__version__\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'
 
 def update_version(path=None):
     "Add or update `__version__` in the main `__init__.py` of the library."
@@ -236,6 +254,15 @@ def update_version(path=None):
 
 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)
+
 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
@@ -247,6 +274,7 @@ def add_init(path=None):
         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
 def write_cells(cells, hdr, file, offset=0, cell_number=True, solo_nb=False):

nbs/api/01_config.ipynb

@@ -139,7 +139,7 @@
     "    license='apache2', # License for the package\n",
     "    copyright:str=None, # Copyright for the package, defaults to '`current_year` onwards, `author`'\n",
     "    status='3', # Development status PyPI classifier\n",
-    "    min_python='3.7', # Minimum Python version PyPI classifier\n",
+    "    min_python='3.9', # Minimum Python version PyPI classifier\n",
     "    audience='Developers', # Intended audience PyPI classifier\n",
     "    language='English', # Language PyPI classifier\n",
     "    recursive:bool_arg=True, # Include subfolders in notebook globs?\n",
@@ -153,6 +153,7 @@
     "    clear_all:bool_arg=False, # Remove all cell metadata and cell outputs?\n",
     "    cell_number:bool_arg=True, # Add cell number to the exported file\n",
     "    put_version_in_init:bool_arg=True, # Add the version to the main __init__.py in nbdev_export\n",
+    "    update_pyproject:bool_arg=True, # Create/update pyproject.toml with correct project name\n",
     "    skip_procs:str='', # A comma-separated list of processors that you want to skip\n",
     "):\n",
     "    \"Apply default settings where missing in `cfg`.\"\n",
@@ -326,7 +327,7 @@
     "\n",
     "'''\n",
     "_nbdev_cfg_sections = {'Python library': 'repo lib_name version min_python license black_formatting',\n",
-    "                       'nbdev': 'doc_path lib_path nbs_path recursive tst_flags put_version_in_init',\n",
+    "                       'nbdev': 'doc_path lib_path nbs_path recursive tst_flags put_version_in_init update_pyproject',\n",
     "                       'Docs': 'branch custom_sidebar doc_host doc_baseurl git_url title',\n",
     "                       'PyPI': 'audience author author_email copyright description keywords language status user'}\n",
     "_nbdev_cfg_tail = '''### Optional ###\n",
@@ -669,6 +670,27 @@
     "##  Exporting a basic module"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#| export\n",
+    "pyproj_tmpl = \"\"\"[build-system]\n",
+    "requires = [\"setuptools>=64.0\"]\n",
+    "build-backend = \"setuptools.build_meta\"\n",
+    "\n",
+    "[project]\n",
+    "name = \"FILL_IN\"\n",
+    "requires-python=\"FILL_IN\"\n",
+    "dynamic = [\"description\", \"version\",\"dependencies\", \"optional-dependencies\", \"readme\", \"requires-python\", \"license\", \"authors\", \"keywords\", \"classifiers\", \"entry-points\", \"urls\"]\n",
+    "\n",
+    "[tool.uv]\n",
+    "cache-keys = [{ file = \"pyproject.toml\" }, { file = \"settings.ini\" }, { file = \"setup.py\" }]\n",
+    "\"\"\""
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -677,7 +699,10 @@
    "source": [
     "#|export\n",
     "_re_version = re.compile(r'^__version__\\s*=.*$', re.MULTILINE)\n",
+    "_re_proj = re.compile(r'^name\\s*=\\s*\".*$', re.MULTILINE)\n",
+    "_re_reqpy = re.compile(r'^requires-python\\s*=\\s*\".*$', re.MULTILINE)\n",
     "_init = '__init__.py'\n",
+    "_pyproj = 'pyproject.toml'\n",
     "\n",
     "def update_version(path=None):\n",
     "    \"Add or update `__version__` in the main `__init__.py` of the library.\"\n",
@@ -692,6 +717,15 @@
     "\n",
     "def _has_py(fs): return any(1 for f in fs if f.endswith('.py'))\n",
     "\n",
+    "def update_proj(path):\n",
+    "    \"Create or update `pyproject.toml` in the project root.\"\n",
+    "    fname = path/_pyproj\n",
+    "    if not fname.exists(): fname.write_text(pyproj_tmpl)\n",
+    "    txt = fname.read_text()\n",
+    "    txt = _re_proj.sub(f'name=\"{get_config().lib_name}\"', txt)\n",
+    "    txt = _re_reqpy.sub(f'requires-python=\">={get_config().min_python}\"', txt)\n",
+    "    fname.write_text(txt)\n",
+    "\n",
     "def add_init(path=None):\n",
     "    \"Add `__init__.py` in all subdirs of `path` containing python files if it's not there already.\"\n",
     "    # we add the lowest-level `__init__.py` files first, which ensures _has_py succeeds for parent modules\n",
@@ -702,7 +736,8 @@
     "        r = Path(r)\n",
     "        subds = (os.listdir(r/d) for d in ds)\n",
     "        if _has_py(fs) or any(filter(_has_py, subds)) and not (r/_init).exists(): (r/_init).touch()\n",
-    "    if get_config().get('put_version_in_init', True): update_version(path)"
+    "    if get_config().get('put_version_in_init', True): update_version(path)\n",
+    "    if get_config().get('update_pyproject', True): update_proj(path.parent)"
    ]
   },
   {

pyproject.toml

@@ -1,3 +1,11 @@
 [build-system]
 requires = ["setuptools>=64.0"]
 build-backend = "setuptools.build_meta"
+
+[project]
+name="nbdev"
+requires-python=">=3.9"
+dynamic = ["description", "version","dependencies", "optional-dependencies", "readme", "license", "authors", "keywords", "classifiers", "entry-points", "urls"]
+
+[tool.uv]
+cache-keys = [{ file = "pyproject.toml" }, { file = "settings.ini" }, { file = "setup.py" }]

settings.ini

@@ -8,8 +8,8 @@ user = AnswerDotAI
 author = Jeremy Howard and Hamel Husain
 author_email = [email protected]
 branch = main
-min_python = 3.7
-version = 2.3.38
+min_python = 3.9
+version = 2.4.0
 audience = Developers
 language = English
 custom_sidebar = True