Skip to content

Latest commit

 

History

History
84 lines (64 loc) · 4.2 KB

README.rst

File metadata and controls

84 lines (64 loc) · 4.2 KB

The Littlest JupyterHub

https://circleci.com/gh/jupyterhub/the-littlest-jupyterhub.svg?style=shield https://readthedocs.org/projects/the-littlest-jupyterhub/badge/?version=latest https://img.shields.io/badge/I_want_to_contribute!-grey?logo=jupyter

The Littlest JupyterHub (TLJH) distribution helps you provide Jupyter Notebooks to 1-100 users on a single server.

The primary audience are people who do not consider themselves 'system administrators' but would like to provide hosted Jupyter Notebooks for their students or users. All users are provided with the same environment, and administrators can easily install libraries into this environment without any specialized knowledge.

See the latest documentation for more information on using The Littlest JupyterHub.

For support questions please search or post to our forum.

See the contributing guide for information on the different ways of contributing to The Littlest JupyterHub.

See this blog post for more information.

Development Status

This project is currently in beta state. Folks have been using installations of TLJH for more than a year now to great success. While we try hard not to, we might still make breaking changes that have no clear upgrade pathway.

Installation

The Littlest JupyterHub (TLJH) requires at least Python 3.6. This fork allows you to specify your Python install. If you're running Ubuntu prior to 18.04 you'll have to install a more up-to-date Python and set its executable path in the environment as TLJH_PYTHON_EXECUTABLE.

We have several tutorials to get you started.

Documentation

Our latest documentation is at: https://the-littlest-jupyterhub.readthedocs.io

We place a high importance on consistency, readability and completeness of documentation. If a feature is not documented, it does not exist. If a behavior is not documented, it is a bug! We try to treat our documentation like we treat our code: we aim to improve it as often as possible.

If something is confusing to you in the documentation, it is a bug. We would be happy if you could file an issue about it - or even better, contribute a documentation fix!