jupyterlab-darkside-ui


Namejupyterlab-darkside-ui JSON
Version 0.1.6 PyPI version JSON
download
home_pagehttps://github.com/dunovank/jupyterlab_darkside_ui
Summarydarkside ui and syntax theme for jupyterlab
upload_time2021-05-04 19:13:48
maintainer
docs_urlNone
authorKyle Dunovan
requires_python>=3.6
licenseBSD-3-Clause
keywords jupyter jupyterlab
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # jupyterlab_darkside_ui

![Github Actions Status](https://github.com/dunovank/jupyterlab_darkside_ui/workflows/Build/badge.svg)

Darkside ui and syntax theme for JupyterLab

## Preview
![](./jupyterlab_darkside_ui.png)

## Requirements

* JupyterLab >= 3.0

## Install
***NOTE:*** After installing and launching `jupyter lab`, the theme still needs to be enabled:
***Settings > JupyterLab Theme > @dunovank/jupyterlab_darkside_ui***

```bash
pip install jupyterlab_darkside_ui
```

## Uninstall

```bash
pip uninstall jupyterlab_darkside_ui
jupyter labextension uninstall @dunovank/jupyterlab_darkside_ui
```


## Develop

* 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.

* 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.

* 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 (see above) 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:

### Build & Watch (Terminal 1)

```bash
# Clone the repo to your local environment
# cd to the jupyterlab_darkside_ui dir
# Install package in editable (-e) mode
pip install -e .

# Link your dev version of
# the extension with JupyterLab
jupyter labextension develop . --overwrite

# Rebuild extension Typescript
# source after making changes
jlpm run build

# Watch the source
# dir in Terminal 1
jlpm run watch
```

### Run JupyterLab (Terminal 2)

```bash
jupyter lab
```

## Publish

```bash
pip install jupyter_packaging twine
```

```bash
python setup.py sdist bdist_wheel && twine upload dist/*
```

```bash
jlpm build:lib && npm publish --access public
```

> TODO
- Bring more fancy ui like in https://github.com/timkpaine/jupyterlab_miami_nights:


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/dunovank/jupyterlab_darkside_ui",
    "name": "jupyterlab-darkside-ui",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "Jupyter,JupyterLab",
    "author": "Kyle Dunovan",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/5a/82/dc925720d0212031778bc4d9444d39af0c5976222cd74bad063a3e42fb35/jupyterlab_darkside_ui-0.1.6.tar.gz",
    "platform": "Linux",
    "description": "# jupyterlab_darkside_ui\n\n![Github Actions Status](https://github.com/dunovank/jupyterlab_darkside_ui/workflows/Build/badge.svg)\n\nDarkside ui and syntax theme for JupyterLab\n\n## Preview\n![](./jupyterlab_darkside_ui.png)\n\n## Requirements\n\n* JupyterLab >= 3.0\n\n## Install\n***NOTE:*** After installing and launching `jupyter lab`, the theme still needs to be enabled:\n***Settings > JupyterLab Theme > @dunovank/jupyterlab_darkside_ui***\n\n```bash\npip install jupyterlab_darkside_ui\n```\n\n## Uninstall\n\n```bash\npip uninstall jupyterlab_darkside_ui\njupyter labextension uninstall @dunovank/jupyterlab_darkside_ui\n```\n\n\n## Develop\n\n* 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.\n\n* 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.\n\n* 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).\n\n* By default, the `jlpm run build` command (see above) 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:\n\n### Build & Watch (Terminal 1)\n\n```bash\n# Clone the repo to your local environment\n# cd to the jupyterlab_darkside_ui dir\n# Install package in editable (-e) mode\npip install -e .\n\n# Link your dev version of\n# the extension with JupyterLab\njupyter labextension develop . --overwrite\n\n# Rebuild extension Typescript\n# source after making changes\njlpm run build\n\n# Watch the source\n# dir in Terminal 1\njlpm run watch\n```\n\n### Run JupyterLab (Terminal 2)\n\n```bash\njupyter lab\n```\n\n## Publish\n\n```bash\npip install jupyter_packaging twine\n```\n\n```bash\npython setup.py sdist bdist_wheel && twine upload dist/*\n```\n\n```bash\njlpm build:lib && npm publish --access public\n```\n\n> TODO\n- Bring more fancy ui like in https://github.com/timkpaine/jupyterlab_miami_nights:\n\n",
    "bugtrack_url": null,
    "license": "BSD-3-Clause",
    "summary": "darkside ui and syntax theme for jupyterlab",
    "version": "0.1.6",
    "split_keywords": [
        "jupyter",
        "jupyterlab"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "04ace0382e34072b2efe23a488f2527d",
                "sha256": "d8e7aa1e0ea68f4e9d3d56069b6f96dfd3d26984fc52296a44d56dd9c9fe8c82"
            },
            "downloads": -1,
            "filename": "jupyterlab_darkside_ui-0.1.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "04ace0382e34072b2efe23a488f2527d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 110996,
            "upload_time": "2021-05-04T19:13:43",
            "upload_time_iso_8601": "2021-05-04T19:13:43.586787Z",
            "url": "https://files.pythonhosted.org/packages/b3/5e/0e517eee08762d68bfd71bce0d410d1f83a77ea972b90265e3abc8c69d6c/jupyterlab_darkside_ui-0.1.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "e66b4b474826460a81da75e5a00db55a",
                "sha256": "b7ba1bb805e6a9b2ef818c1a38524e35670aded68196c565e446759c0b7cd678"
            },
            "downloads": -1,
            "filename": "jupyterlab_darkside_ui-0.1.6.tar.gz",
            "has_sig": false,
            "md5_digest": "e66b4b474826460a81da75e5a00db55a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 34227,
            "upload_time": "2021-05-04T19:13:48",
            "upload_time_iso_8601": "2021-05-04T19:13:48.118900Z",
            "url": "https://files.pythonhosted.org/packages/5a/82/dc925720d0212031778bc4d9444d39af0c5976222cd74bad063a3e42fb35/jupyterlab_darkside_ui-0.1.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-05-04 19:13:48",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "dunovank",
    "error": "Could not fetch GitHub repository",
    "lcname": "jupyterlab-darkside-ui"
}
        
Elapsed time: 0.23968s