# epistemix_jupyterlab_theme
Epistemix theme for JupyterLab.
## Requirements
- JupyterLab >= 3.0
## Install
To install the extension from PyPI, execute:
```bash
pip install epistemix-jupyterlab-theme
```
## Uninstall
To remove the extension, execute:
```bash
pip uninstall epistemix-jupyterlab-theme
```
## Contributing
### Development install
Note: You will need NodeJS to build the extension package.
First install [Miniconda](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html) or some kind of package/environment manager.
Then create an environment for jupyterlab and activate that environment.
```bash
# Create environment
conda create -n jupyterlab-ext --override-channels --strict-channel-priority -c conda-forge -c nodefaults jupyterlab=3 nodejs jupyter-packaging git
```
```bash
# Activate environment
conda activate jupyterlab-ext
```
Note: You’ll need to run the command above in each new terminal you open before you can work with the tools you installed in the jupyterlab-ext environment.
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.
```bash
# Clone the repo to your local environment
# Change directory to the epistemix_jupyterlab_theme directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm 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.
```bash
# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm watch
# Run JupyterLab in another terminal
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 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
```
### Development install in a Docker container
See the README in the `docker_dev_environment` folder.
### Development uninstall
```bash
pip uninstall epistemix_jupyterlab_theme
```
In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
folder is located. Then you can remove the symlink named `epistemix_jupyterlab_theme` within that folder.
### Packaging the extension
See [RELEASE](RELEASE.md)
Raw data
{
"_id": null,
"home_page": "https://github.com/github_username/epistemix_jupyterlab_theme",
"name": "epistemix-jupyterlab-theme",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "Jupyter,JupyterLab,JupyterLab3",
"author": "Blake Boucher",
"author_email": "blake.boucher@epistemix.com",
"download_url": "https://files.pythonhosted.org/packages/11/5a/6739e004034b9ceaa7779fef6e01a56ead574659399e8d48116e9e3fe548/epistemix_jupyterlab_theme-0.3.6.tar.gz",
"platform": "Linux",
"description": "# epistemix_jupyterlab_theme\n\nEpistemix theme for JupyterLab.\n\n## Requirements\n\n- JupyterLab >= 3.0\n\n## Install\n\nTo install the extension from PyPI, execute:\n\n```bash\npip install epistemix-jupyterlab-theme\n```\n\n## Uninstall\n\nTo remove the extension, execute:\n\n```bash\npip uninstall epistemix-jupyterlab-theme\n```\n\n## Contributing\n\n### Development install\n\nNote: You will need NodeJS to build the extension package.\n\nFirst install [Miniconda](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html) or some kind of package/environment manager.\n\nThen create an environment for jupyterlab and activate that environment.\n\n```bash\n# Create environment\nconda create -n jupyterlab-ext --override-channels --strict-channel-priority -c conda-forge -c nodefaults jupyterlab=3 nodejs jupyter-packaging git\n```\n\n```bash\n# Activate environment\nconda activate jupyterlab-ext\n```\n\nNote: You\u2019ll need to run the command above in each new terminal you open before you can work with the tools you installed in the jupyterlab-ext environment.\n\nThe `jlpm` command is JupyterLab's pinned version of\n[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use\n`yarn` or `npm` in lieu of `jlpm` below.\n\n```bash\n# Clone the repo to your local environment\n# Change directory to the epistemix_jupyterlab_theme directory\n# Install package in development mode\npip install -e .\n# Link your development version of the extension with JupyterLab\njupyter labextension develop . --overwrite\n# Rebuild extension Typescript source after making changes\njlpm build\n```\n\nYou 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```bash\n# Watch the source directory in one terminal, automatically rebuilding when needed\njlpm watch\n# Run JupyterLab in another terminal\njupyter lab\n```\n\nWith 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\nBy default, the `jlpm 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:\n\n```bash\njupyter lab build --minimize=False\n```\n\n### Development install in a Docker container\n\nSee the README in the `docker_dev_environment` folder.\n\n### Development uninstall\n\n```bash\npip uninstall epistemix_jupyterlab_theme\n```\n\nIn development mode, you will also need to remove the symlink created by `jupyter labextension develop`\ncommand. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`\nfolder is located. Then you can remove the symlink named `epistemix_jupyterlab_theme` within that folder.\n\n### Packaging the extension\n\nSee [RELEASE](RELEASE.md)\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Epistemix theme for JupyterLab.",
"version": "0.3.6",
"split_keywords": [
"jupyter",
"jupyterlab",
"jupyterlab3"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f9405c7bd014c5bd92a35a8822f6951e589549e8da519a6986ab76247d025a0e",
"md5": "362fa17a3e1623a2406befe2af76a9a8",
"sha256": "ade0bcbdb1cc2a07631d210b2be046f8f3a752c0734265c5da28a5f6360be472"
},
"downloads": -1,
"filename": "epistemix_jupyterlab_theme-0.3.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "362fa17a3e1623a2406befe2af76a9a8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 436910,
"upload_time": "2023-03-15T18:25:47",
"upload_time_iso_8601": "2023-03-15T18:25:47.869065Z",
"url": "https://files.pythonhosted.org/packages/f9/40/5c7bd014c5bd92a35a8822f6951e589549e8da519a6986ab76247d025a0e/epistemix_jupyterlab_theme-0.3.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "115a6739e004034b9ceaa7779fef6e01a56ead574659399e8d48116e9e3fe548",
"md5": "a3492bb7fc0f9b93ab331166d7a2d9f1",
"sha256": "c9773ba2f5a14c0402a38be8f83735a94d699b24246a8c98d2ce3d42d5abcc99"
},
"downloads": -1,
"filename": "epistemix_jupyterlab_theme-0.3.6.tar.gz",
"has_sig": false,
"md5_digest": "a3492bb7fc0f9b93ab331166d7a2d9f1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 507437,
"upload_time": "2023-03-15T18:25:49",
"upload_time_iso_8601": "2023-03-15T18:25:49.778584Z",
"url": "https://files.pythonhosted.org/packages/11/5a/6739e004034b9ceaa7779fef6e01a56ead574659399e8d48116e9e3fe548/epistemix_jupyterlab_theme-0.3.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-15 18:25:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "github_username",
"github_project": "epistemix_jupyterlab_theme",
"lcname": "epistemix-jupyterlab-theme"
}
JSON
