skillsnetwork-authoring-extension


Nameskillsnetwork-authoring-extension JSON
Version 0.2.5 PyPI version JSON
download
home_pagehttps://github.com/ibm-skills-network/skillsnetwork-authoring-extension
SummaryJupterLab/JupyerLite extension for Skills Network Authoring
upload_time2022-06-29 19:03:12
maintainer
docs_urlNone
authorJenny Cao
requires_python>=3.7
licenseBSD-3-Clause
keywords jupyter jupyterlab jupyterlab3
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # skillsnetwork-authoring-extension

JupterLab/JupyerLite extension for Skills Network Authoring

## Demo

### Edit a Lab via Token

![](https://github.com/ibm-skills-network/skillsnetwork-authoring-extension/blob/main/demo_sn_authoring_extension2.gif)

## Requirements

* JupyterLab >= 3.0

## Install

To install the extension, execute:

```bash
pip install skillsnetwork-authoring-extension
```

After installing, enable the extension:

```bash
jupyter serverextension enable skillsnetwork-authoring-extension
```

## Uninstall

To remove the extension, execute:

```bash
pip uninstall skillsnetwork-authoring-extension
```


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

```bash
# Clone the repo to your local environment
# Change directory to the skillsnetwork-authoring-extension 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 uninstall

```bash
pip uninstall skillsnetwork-authoring-extension
```

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 `skillsnetwork-authoring-extension` within that folder.

### Packaging the extension

```bash
# Package the python source package .tar.gz and binary package .whl
pip install build twine
python -m build
```

Also see [RELEASE](RELEASE.md)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ibm-skills-network/skillsnetwork-authoring-extension",
    "name": "skillsnetwork-authoring-extension",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "Jupyter,JupyterLab,JupyterLab3",
    "author": "Jenny Cao",
    "author_email": "jenny.cao@ibm.com",
    "download_url": "https://files.pythonhosted.org/packages/08/14/bbb021243fa0175868ca153a46c012058bc8c475e29d2f2c3c96b71a3028/skillsnetwork-authoring-extension-0.2.5.tar.gz",
    "platform": "Linux",
    "description": "# skillsnetwork-authoring-extension\n\nJupterLab/JupyerLite extension for Skills Network Authoring\n\n## Demo\n\n### Edit a Lab via Token\n\n![](https://github.com/ibm-skills-network/skillsnetwork-authoring-extension/blob/main/demo_sn_authoring_extension2.gif)\n\n## Requirements\n\n* JupyterLab >= 3.0\n\n## Install\n\nTo install the extension, execute:\n\n```bash\npip install skillsnetwork-authoring-extension\n```\n\nAfter installing, enable the extension:\n\n```bash\njupyter serverextension enable skillsnetwork-authoring-extension\n```\n\n## Uninstall\n\nTo remove the extension, execute:\n\n```bash\npip uninstall skillsnetwork-authoring-extension\n```\n\n\n## Contributing\n\n### Development install\n\nNote: You will need NodeJS to build the extension package.\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 skillsnetwork-authoring-extension 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 uninstall\n\n```bash\npip uninstall skillsnetwork-authoring-extension\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 `skillsnetwork-authoring-extension` within that folder.\n\n### Packaging the extension\n\n```bash\n# Package the python source package .tar.gz and binary package .whl\npip install build twine\npython -m build\n```\n\nAlso see [RELEASE](RELEASE.md)\n",
    "bugtrack_url": null,
    "license": "BSD-3-Clause",
    "summary": "JupterLab/JupyerLite extension for Skills Network Authoring",
    "version": "0.2.5",
    "split_keywords": [
        "jupyter",
        "jupyterlab",
        "jupyterlab3"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "2577184d079a010f8035ac745b6365b8",
                "sha256": "2de2ce2d9dd0f209f4f50a74b25b9956769d55dc83eccc494dd8bf349c7eb314"
            },
            "downloads": -1,
            "filename": "skillsnetwork_authoring_extension-0.2.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2577184d079a010f8035ac745b6365b8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 164867,
            "upload_time": "2022-06-29T19:03:10",
            "upload_time_iso_8601": "2022-06-29T19:03:10.732173Z",
            "url": "https://files.pythonhosted.org/packages/ea/8b/ab4a0e40e4ecc4a8191f75971d54e58588d8c4b7c398289ab861b6576b15/skillsnetwork_authoring_extension-0.2.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "7f081a6ddcc504f786cb4ce793cae451",
                "sha256": "bdcded261a2ac7ceeb8799e0f51d226775a8bf1966558780eb65cc638722164c"
            },
            "downloads": -1,
            "filename": "skillsnetwork-authoring-extension-0.2.5.tar.gz",
            "has_sig": false,
            "md5_digest": "7f081a6ddcc504f786cb4ce793cae451",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 79762,
            "upload_time": "2022-06-29T19:03:12",
            "upload_time_iso_8601": "2022-06-29T19:03:12.932949Z",
            "url": "https://files.pythonhosted.org/packages/08/14/bbb021243fa0175868ca153a46c012058bc8c475e29d2f2c3c96b71a3028/skillsnetwork-authoring-extension-0.2.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-06-29 19:03:12",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "ibm-skills-network",
    "github_project": "skillsnetwork-authoring-extension",
    "lcname": "skillsnetwork-authoring-extension"
}
        
Elapsed time: 0.65019s