jupyterlab-theme-CA 0.1.1
Composable theme for JupyterLab 3.x
License: BSD-3-Clause
Requires Python: >=3.6
Keywords: Jupyter,JupyterLab,JupyterLab3

# jupyterlab-theme-CA

![Github Actions Status](https://github.com/gdaccache/jupyterlab-theme-composable/workflows/Build/badge.svg)
![License](https://img.shields.io/github/license/gdaccache/jupyterlab-theme-composable.svg)
![GitHub last commit](https://img.shields.io/github/last-commit/gdaccache/jupyterlab-theme-composable)
![GitHub stars](https://img.shields.io/github/stars/gdaccache/jupyterlab-theme-composable)
[![NPM Version](https://img.shields.io/npm/v/jupyterlab-theme-composable.svg)](https://npmjs.org/package/jupyterlab-theme-composable)
![Monthly Downloads](https://img.shields.io/npm/dm/jupyterlab-theme-composable.svg?label=npm%20downloads)
[![PyPI](https://img.shields.io/pypi/v/jupyterlab_theme_composable)](https://pypi.org/project/jupyterlab-theme-composable/)
![PyPI - Downloads](https://img.shields.io/pypi/dm/jupyterlab_theme_composable?label=pypi%20downloads)

Composable is a theme extension for JupyterLab 3. This theme is the custom styling for Composable Analytics' integration with Jupyterlabs, known as DataLabs.

## Prerequisites

* JupyterLab

## Version

* `v0.1.1`
    * Initial version. This version is compatible with JupyterLab 3. 

## Requirements

* JupyterLab >= 3.0

## Install

To install it as a prebuilt extension (requires JupyterLab >= 3.0):

```bash
pip install jupyterlab_theme_CA
```

Or install it as a source extension:

```bash
jupyter labextension install jupyterlab-theme-CA
```

Apply theme by checking `Settings -> Jupyterlab Theme -> Jupyterlab Composable`

To enable theme scrollbars, in JupyterLab, either

- navigate to `Settings -> Advanced Settings Editor -> Theme`, and add `"theme-scrollbars": true` to `User Preferences` or
- check `Settings -> Jupyterlab Theme -> Theme Scrollbars`

## Contributing

### Development install

Note: You will need NodeJS to build the extension package.

The `jlpm` command is JupyterLab's pinned version of
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
`yarn` or `npm` in lieu of `jlpm` below.

Clone the repo to your local environment. Change directory to the `jupyterlab_theme_CA` directory. Install package in `development` mode:

```bash
pip install -e .
```

Link your development version of the extension with JupyterLab:
```bash
jupyter labextension develop . --overwrite
```

Rebuild extension Typescript source after making changes:
```bash
jlpm run build
```

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension. Watch the source directory in one terminal, automatically rebuilding when needed:
```bash
jlpm run watch
```

Run JupyterLab in another terminal:
```bash
jupyter lab
```

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

By default, the `jlpm run build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

```bash
jupyter lab build --minimize=False
```

### Uninstall

```bash
pip uninstall jupyterlab_theme_CA
```

or

```bash
jupyter labextension uninstall jupyterlab-theme-CA
```