zhangyiss/the-littlest-jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/the-littlest-jupyterhub.git synced 2025-12-18 21:54:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #551 from jtpio/plugin-gallery

Browse Source
This commit is contained in:
Yuvi Panda
2020-04-21 16:24:50 +05:30
committed by GitHub
parent e9ab81033d dc247bc579
commit 279403bb9e
1 changed files with 24 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
docs/contributing/plugins.rst
View File

@@ -4,7 +4,7 @@
TLJH Plugins TLJH Plugins
============ ============
TLJH plugins are the official way to make customized 'spins' or 'stacks' TLJH plugins are the official way to make customized 'spins' or 'stacks'
with TLJH as the base. For example, the earth sciences community can make with TLJH as the base. For example, the earth sciences community can make
a plugin that installs commonly used packages, set up authentication a plugin that installs commonly used packages, set up authentication
and pre-download useful datasets. The mybinder.org community can and pre-download useful datasets. The mybinder.org community can
@@ -19,7 +19,7 @@ plugin functionality. TLJH exposes specific **hooks** that your plugin
can provide implementations for. This allows us to have specific hook can provide implementations for. This allows us to have specific hook
points in the application that can be explicitly extended by plugins, points in the application that can be explicitly extended by plugins,
balancing the need to change TLJH internals in the future with the balancing the need to change TLJH internals in the future with the
stability required for a good plugin ecosystem. stability required for a good plugin ecosystem.
Writing a simple plugins Writing a simple plugins
======================== ========================
@@ -38,7 +38,7 @@ we recommend they live in one file.
For ``tljh-simple``, the repository's structure should look like: For ``tljh-simple``, the repository's structure should look like:
.. code-block:: none .. code-block:: none
tljh_simple: tljh_simple:
- tljh_simple.py - tljh_simple.py
- setup.py - setup.py
@@ -47,7 +47,7 @@ For ``tljh-simple``, the repository's structure should look like:
The ``README.md`` (or ``README.rst`` file) contains human readable The ``README.md`` (or ``README.rst`` file) contains human readable
information about what your plugin does for your users. ``LICENSE`` information about what your plugin does for your users. ``LICENSE``
specifies the license used by your plugin - we recommend the specifies the license used by your plugin - we recommend the
3-Clause BSD License, since that is what is used by TLJH itself. 3-Clause BSD License, since that is what is used by TLJH itself.
``setup.py`` - metadata & registration ``setup.py`` - metadata & registration
@@ -78,7 +78,7 @@ This is a mostly standard ``setup.py`` file. ``entry_points={"tljh": ["simple =
----------------------------------- -----------------------------------
In ``tljh_simple.py``, you provide implementations for whichever hooks In ``tljh_simple.py``, you provide implementations for whichever hooks
you want to extend. you want to extend.
A hook implementation is a function that has the following characteristics: A hook implementation is a function that has the following characteristics:
@@ -93,7 +93,7 @@ in the source repository.
This example provides an implementation for the ``tljh_extra_user_conda_packages`` This example provides an implementation for the ``tljh_extra_user_conda_packages``
hook, which can return a list of conda packages that'll be installed in users' hook, which can return a list of conda packages that'll be installed in users'
environment from conda-forge. environment from conda-forge.
.. code-block:: python .. code-block:: python
@@ -114,6 +114,22 @@ Publishing plugins
Plugins are python packages and should be published on PyPI. Users Plugins are python packages and should be published on PyPI. Users
can also install them directly from GitHub - although this is can also install them directly from GitHub - although this is
not good long term practice. not good long term practice.
The python package should be named ``tljh-<pluginname>``. The python package should be named ``tljh-<pluginname>``.
List of known plugins
=====================
If you are looking for a way to extend or customize your TLJH deployment, you might want to look for existing plugins.
Here is a non-exhaustive list of known TLJH plugins:
- `tljh-pangeo <https://github.com/yuvipanda/tljh-pangeo>`_: TLJH Plugin for setting up the Pangeo Stack
- `tljh-voila-gallery <https://github.com/voila-dashboards/tljh-voila-gallery>`_: TLJH plugin that installs a gallery of Voilà dashboards
If you have authored a plugin, please open a PR to add it to this list!
We also recommend adding the ``tljh-plugin`` topic to the GitHub repository to make it more discoverable:
`https://github.com/topics/tljh-plugin <https://github.com/topics/tljh-plugin>`_