Remove entry points

Author: afshin

README.md

@@ -1,3 +1,39 @@
 # pytest-jupyter
 
 A set of pytest plugins for Jupyter libraries and extensions.
+
+## Basic Usage
+
+First, install `pytest-jupyter` from PyPI using pip:
+```bash
+pip install pytest-jupyter
+```
+This installs the basic pytest-jupyter package that insludes fixture definitions for the various Jupyter-based pytest plugins.
+
+To use one of these plugins, you'll also need to install their dependencies. This requires a second `pip install` call. For example, if you'd like to use the `jupyter_server` plugin, you'll need to call:
+```bash
+pip install "pytest-jupyter[server]"
+```
+This *should* install everything you need for the plugin to work.
+
+To use a plugin, add it to the `pytest_plugins` list in the `conftest.py` of your project's root test directory.
+```python
+# inside the conftest.py
+
+pytest_plugins = ["pytest_jupyter.jupyter_server"]
+```
+All fixtures inside the plugin (e.g. jupyter_server) will be available to all of your project's unit tests. You can use a fixtures by passing it as an argument to your unit test function:
+```python
+async def test_jupyter_server_api(jp_fetch):
+    # Send request to a temporary Jupyter Server Web Application
+    response = await jp_fetch("api/spec.yml")
+
+    # Confirm that the request is successful.
+    assert response.code == 200
+```
+
+You can list the fixtures for a given plugin using the `--fixtures` argument from the pytest command line interface:
+```bash
+pytest --fixtures -p pytest_jupyter.jupyter_server
+```
+or by calling the `pytest --fixtures` where the plugin is listed in the `pytest_plugins` variable of a given test directory.

docs/index.md

@@ -4,13 +4,25 @@ A set of [pytest plugins](https://docs.pytest.org/en/stable/plugins.html) for Ju
 
 ## Basic Usage
 
-Install `pytest-jupyter` from PyPI using pip:
-```
+First, install `pytest-jupyter` from PyPI using pip:
+```bash
 pip install pytest-jupyter
 ```
+This installs the basic pytest-jupyter package that insludes fixture definitions for the various Jupyter-based pytest plugins.
 
-Once it's installed, all fixtures from `pytest-jupyter` will be discoverable by Pytest. Pass any fixture to your unit test function to begin using it, like so:
+To use one of these plugins, you'll also need to install their dependencies. This requires a second `pip install` call. For example, if you'd like to use the `jupyter_server` plugin, you'll need to call:
+```bash
+pip install "pytest-jupyter[server]"
+```
+This *should* install everything you need for the plugin to work.
 
+To use a plugin, add it to the `pytest_plugins` list in the `conftest.py` of your project's root test directory.
+```python
+# inside the conftest.py
+
+pytest_plugins = ["pytest_jupyter.jupyter_server"]
+```
+All fixtures inside the plugin (e.g. jupyter_server) will be available to all of your project's unit tests. You can use a fixtures by passing it as an argument to your unit test function:
 ```python
 async def test_jupyter_server_api(jp_fetch):
     # Send request to a temporary Jupyter Server Web Application
@@ -20,6 +32,12 @@ async def test_jupyter_server_api(jp_fetch):
     assert response.code == 200
 ```
 
+You can list the fixtures for a given plugin using the `--fixtures` argument from the pytest command line interface:
+```bash
+pytest --fixtures -p pytest_jupyter.jupyter_server
+```
+or by calling the `pytest --fixtures` where the plugin is listed in the `pytest_plugins` variable of a given test directory.
+
 
 ```{toctree}
 :maxdepth: 2

docs/plugins/jupyter_core.md

@@ -1,6 +1,12 @@
 # Jupyter Core plugin
 
-The following fixtures are useful for setting up a test environment for Jupyter extensions and applications.
+The following plugin is useful for setting up a test environment for Jupyter extensions and applications.
+
+To use this plugin, install the dependencies for this plugin:
+```
+pip install 'pytest-jupyter[core]'
+```
+and list the plugin in the `conftest.py` file at the root of your project's test directory.
 
 ## Fixtures
 

docs/plugins/jupyter_server.md

@@ -2,8 +2,15 @@
 
 The jupyter_server module provides fixtures for automatically setting-up/tearing-down Jupyter Servers.
 
+To use this plugin, install the dependencies for this plugin:
+```
+pip install 'pytest-jupyter[server]'
+```
+and list the plugin in the `conftest.py` file at the root of your project's test directory.
+
 You can make requests to a *test server* using the `jp_fetch` and `jp_ws_fetch` fixtures.
 
+
 ## Fixtures
 
 ```{eval-rst}

pytest_jupyter/jupyter_core.py

@@ -1,14 +1,26 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
-
-import jupyter_core.paths
 import os
 import pytest
 import sys
 
-from .utils import mkdir
+# The try block is needed so that the documentation can
+# still build without needed to install all the dependencies.
+try:
+    import jupyter_core.paths
+
+except (ModuleNotFoundError, ImportError) as e:
+    import warnings
+    warnings.warn(
+        "The jupyter_core plugin has not been installed. "
+        "If you're trying to use this plugin and you've installed "
+        "`pytest-jupyter`, there is likely one more step "
+        "you need. Try: `pip install 'pytest-jupyter[core]'`"
+    )
 
 
+from .utils import mkdir
+
 @pytest.fixture
 def jp_home_dir(tmp_path):
     """Provides a temporary HOME directory value."""

pytest_jupyter/jupyter_server.py

@@ -1,26 +1,48 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 
-import jupyter_core.paths
-import nbformat
 import os
 import json
 import pytest
 import shutil
-import tornado
 import urllib.parse
 
 from binascii import hexlify
-from jupyter_server.extension import serverextension
-from jupyter_server.serverapp import ServerApp
-from jupyter_server.utils import url_path_join
-from jupyter_server.services.contents.filemanager import FileContentsManager
-from jupyter_server.services.contents.largefilemanager import LargeFileManager
-from tornado.escape import url_escape
-from traitlets.config import Config
+
+# The try block is needed so that the documentation can
+# still build without needed to install all the dependencies.
+try:
+    import tornado
+    from tornado.escape import url_escape
+    import jupyter_core.paths
+    import nbformat
+    from traitlets.config import Config
+
+    from jupyter_server.extension import serverextension
+    from jupyter_server.serverapp import ServerApp
+    from jupyter_server.utils import url_path_join
+    from jupyter_server.services.contents.filemanager import FileContentsManager
+    from jupyter_server.services.contents.largefilemanager import LargeFileManager
+
+except (ModuleNotFoundError, ImportError) as e:
+    import warnings
+    warnings.warn(
+        "The server plugin has not been installed. "
+        "If you're trying to use this plugin and you've installed "
+        "`pytest-jupyter`, there is likely one more step "
+        "you need. Try: `pip install 'pytest-jupyter[server]'`"
+    )
+
 
 from .utils import mkdir
 
+# List of dependencies needed for this plugin.
+pytest_plugins = [
+    "pytest_tornasync",
+    "pytest_jupyter.jupyter_core"
+]
+
+
 # NOTE: This is a temporary fix for Windows 3.8
 # We have to override the io_loop fixture with an
 # asyncio patch. This will probably be removed in

setup.py

@@ -12,38 +12,39 @@
 readme_path = HERE.joinpath('README.md')
 README = readme_path.read_text()
 
+# Build the extra requirements for each plugin.
+EXTRA_REQUIRES = {
+    'docs': [
+        'Sphinx',
+        'myst_parser',
+        'pydata_sphinx_theme',
+    ],
+    'core': [
+        'jupyter_core'
+    ],
+    'server': [
+        'nbformat',
+        'jupyter_core',
+        'jupyter_server',
+        'pytest-tornasync'
+    ]
+}
+
 setup_args = dict(
     name=NAME,
     version=VERSION,
     description=DESCRIPTION,
     long_description=README,
     long_description_content_type='text/markdown',
-    packages=find_packages(),
+    packages=find_packages('.', exclude=['tests', 'tests.*']),
     author='Jupyter Development Team',
     author_email='[email protected]',
     url='http://jupyter.org',
     license='BSD',
     platforms="Linux, Mac OS X, Windows",
     keywords=['Jupyter', 'pytest'],
-    install_requires=[
-        'traitlets',
-        'tornado',
-        'pytest',
-        'nbformat',
-        'pytest-tornasync',
-        'jupyter_core',
-        'jupyter_server'
-    ],
-    extras_require={
-        'docs': ['Sphinx', 'myst_parser', 'pydata_sphinx_theme']
-    },
-    # the following makes a plugin available to pytest
-    entry_points={
-        "pytest11": [
-            "pytest-jupyterserver = pytest_jupyter.jupyter_server",
-            "pytest-jupytercore = pytest_jupyter.jupyter_core"
-        ]
-    },
+    install_requires=['pytest'],
+    extras_require=EXTRA_REQUIRES,
     # custom PyPI classifier for pytest plugins
     classifiers=["Framework :: Pytest"],
 )