Merge pull request #68 from Zsailer/jupyter-packaging-1

Use Jupyter Packaging and other cleanup
jupyter · Oct 21, 2021 · 355087d · 355087d
2 parents f5b87d7 + 032592c
commit 355087d
Show file tree

Hide file tree

Showing 18 changed files with 96 additions and 820 deletions.
diff --git a/.github/workflows/pythonpackage.yml b/.github/workflows/pythonpackage.yml
@@ -53,4 +53,4 @@ jobs:
           jupyter nbclassic -h
       - name: Test with pytest
         run: |
-          pytest -vv --cov nbclassic --cov-report term-missing:skip-covered
+          pytest -vv --cov=nbclassic nbclassic --cov-report term-missing:skip-covered
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,2 +1 @@
 include LICENSE
-include setupbase.py
diff --git a/nbclassic/__init__.py b/nbclassic/__init__.py
@@ -1,7 +1,7 @@
-from .notebookapp import NotebookApp
-
-
 def _jupyter_server_extension_paths():
+    # Locally import to avoid install errors.
+    from .notebookapp import NotebookApp
+
     return [
         {
             'module': 'nbclassic.notebookapp',
@@ -11,4 +11,4 @@ def _jupyter_server_extension_paths():
         {
             'module': 'nbclassic.nbserver',
         }
-    ]
+    ]
diff --git a/tests/conftest.py → nbclassic/conftest.py b/tests/conftest.py → nbclassic/conftest.py
diff --git a/tests/__init__.py → nbclassic/tests/__init__.py b/tests/__init__.py → nbclassic/tests/__init__.py
diff --git a/tests/confs/jupyter_my_ext_config.py → ...ssic/tests/confs/jupyter_my_ext_config.py b/tests/confs/jupyter_my_ext_config.py → ...ssic/tests/confs/jupyter_my_ext_config.py
diff --git a/tests/confs/jupyter_notebook_config.py → ...ic/tests/confs/jupyter_notebook_config.py b/tests/confs/jupyter_notebook_config.py → ...ic/tests/confs/jupyter_notebook_config.py
diff --git a/tests/confs/jupyter_server_config.py → ...ssic/tests/confs/jupyter_server_config.py b/tests/confs/jupyter_server_config.py → ...ssic/tests/confs/jupyter_server_config.py
diff --git a/tests/shim/__init__.py → nbclassic/tests/shim/__init__.py b/tests/shim/__init__.py → nbclassic/tests/shim/__init__.py
diff --git a/tests/shim/mockextension.py → nbclassic/tests/shim/mockextension.py b/tests/shim/mockextension.py → nbclassic/tests/shim/mockextension.py
@@ -11,7 +11,7 @@
 def _jupyter_server_extension_points():
     return [
         {
-            "module": "tests.shim.mockextension",
+            "module": "nbclassic.tests.shim.mockextension",
             "app": MockExtensionApp
         }
     ]
@@ -35,4 +35,4 @@ class MockExtensionApp(
     # ------ Traits found ServerApp and MockExtensionApp
 
     allow_origin = Unicode(config=True)
-    allow_origin_pat = Unicode(config=True)
+    allow_origin_pat = Unicode(config=True)
diff --git a/tests/shim/test_extension.py → nbclassic/tests/shim/test_extension.py b/tests/shim/test_extension.py → nbclassic/tests/shim/test_extension.py
@@ -45,7 +45,7 @@ def jp_server_config():
         "ServerApp": {
             "jpserver_extensions": {
                 "nbclassic": True,
-                "tests.shim.mockextension": True
+                "nbclassic.tests.shim.mockextension": True
             }
         }
     }

diff --git a/tests/shim/test_nbclassic.py → nbclassic/tests/shim/test_nbclassic.py b/tests/shim/test_nbclassic.py → nbclassic/tests/shim/test_nbclassic.py
diff --git a/tests/test_nbserver.py → nbclassic/tests/test_nbserver.py b/tests/test_nbserver.py → nbclassic/tests/test_nbserver.py
diff --git a/tests/test_notebookapp.py → nbclassic/tests/test_notebookapp.py b/tests/test_notebookapp.py → nbclassic/tests/test_notebookapp.py
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,30 @@
+[build-system]
+requires = ["jupyter_packaging~=0.9,<2"]
+build-backend = "jupyter_packaging.build_api"
+
+[tool.check-manifest]
+ignore = ["tbump.toml", ".*", "conftest.py"]
+
+[tool.pytest.ini_options]
+addopts = "--doctest-modules"
+norecursedirs = ["confs"]
+testpaths = [
+    "nbclassic/tests"
+]
+
+[tool.jupyter-releaser]
+skip = ["check-links"]
+
+[tool.tbump.version]
+current = "0.3.2"
+regex = '''
+  (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)
+  ((?P<channel>a|b|rc|.dev)(?P<release>\d+))?
+'''
+
+[tool.tbump.git]
+message_template = "Bump to {new_version}"
+tag_template = "v{new_version}"
+
+[[tool.tbump.file]]
+src = "nbclassic/__version__.py"
diff --git a/setup.cfg b/setup.cfg
@@ -1,4 +1,58 @@
-[tool:pytest]
-addopts =
-	--color=yes
-    -s
+[metadata]
+name = nbclassic
+version = attr: nbclassic.__version__.__version__
+description = Jupyter Notebook as a Jupyter Server extension.
+long_description = file: README.md
+long_description_content_type = text/markdown
+license_file = LICENSE
+author = Jupyter Development Team
+author_email = jupyter@googlegroups.com
+url = https://jupyter.org
+platforms = Linux, Mac OS X, Windows
+keywords = ipython, jupyter
+classifiers =
+    Intended Audience :: Developers
+    Intended Audience :: System Administrators
+    Intended Audience :: Science/Research
+    License :: OSI Approved :: BSD License
+    Programming Language :: Python
+    Programming Language :: Python :: 3.6
+    Programming Language :: Python :: 3.7
+    Programming Language :: Python :: 3.8
+    Programming Language :: Python :: 3.9
+
+[options]
+zip_safe = False
+include_package_data = True
+packages = find:
+python_requires = >=3.6
+install_requires =
+    notebook<7
+    jupyter_server~=1.8
+
+[options.data_files]
+etc/jupyter/jupyter_server_config.d =
+    jupyter_server_config.d/nbclassic.json
+
+
+[options.extras_require]
+test =
+    pytest
+    pytest-tornasync
+    pytest-console-scripts
+
+[options.entry_points]
+console_scripts =
+    jupyter-nbclassic = nbclassic.notebookapp:main
+
+[options.packages.find]
+exclude = ['docs*']
+
+[flake8]
+ignore = E, C, W, F401, F403, F811, F841, E402, I100, I101, D400
+builtins = c, get_config
+exclude =
+    .cache,
+    .github,
+    docs,
+    setup.py
diff --git a/setup.py b/setup.py