Metadata-Version: 2.1
Name: qhub-jupyterhub-theme
Version: 0.2.1
Summary: QHub jupyterhub theme
Home-page: https://github.com/quansight/qhub_jupyterhub_theme
Author: Quansight
License: UNKNOWN
Project-URL: Bug Reports, https://github.com/quansight/qhub_jupyterhub_theme
Project-URL: Source, https://github.com/quansight/qhub_jupyterhub_theme
Description: # Custom JupyterHub Template for QHub
        
        This repo contains html jinja2 templates for customising the
        appearance of JupyterHub. Each HTML file here will override the files
        in https://github.com/jupyterhub/jupyterhub/tree/master/share/jupyter/hub/templates.
        
        ## Usage
        
        Install `qhub_jupyterhub_theme` in your environment
        
        ```shell
        pip install qhub_jupyterhub_theme
        ```
        
        Add the following to the jupyterhub configuration to pickup the new
        jinja2 templates directory and static files.
        
        ```python
        import tornado.web
        import qhub_jupyterhub_theme
        
        c.JupyterHub.extra_handlers = [
            (r'/custom/(.*)', tornado.web.StaticFileHandler, {"path": qhub_jupyterhub_theme.STATIC_PATH}),
        ]
        
        c.JupyterHub.template_paths = [
            qhub_jupyterhub_theme.TEMPLATE_PATH
        ]
        ```
        
        Finally customize the templates via the `template_vars`. Current
        options are:
         - `hub_title`
         - `hub_subtitle`
         - `welcome`
         - `logo`
         
        Inspiration is in the test jupyterhub configuration
        `test_jupyterhub_config.py`.
        
        ```python
        c.JupyterHub.template_vars = {
            'hub_title': 'This is QHub',
            'hub_subtitle': 'your scalable open source data science laboratory.',
            'welcome': 'have fun.',
        }
        ```
        
        ## Testing
        
        Install the development environment
        
        ```shell
        conda env install -f environment.yaml
        ```
        
        You do not need to restart jupyterhub to see changes in `custom` and
        `templates`. Run jupyterhub via the test script
        
        ```shell
        jupyterhub --config test_jupyterhub_config.py
        ```
        
Keywords: jupyterhub theme
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, <4
Description-Content-Type: text/markdown
