| Name | jupyterlab-stata-highlight2 JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | |
| Summary | JupyterLab extension for Stata syntax highlighting similar to the Stata IDE's. |
| upload_time | 2023-01-25 13:30:46 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | The MIT License (MIT) Copyright (c) 2022, Tim Huegerich Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
jupyter
jupyterlab
jupyterlab3
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# jupyterlab_stata_highlight2
JupyterLab extension for Stata syntax highlighting similar to the Stata IDE's.
## Requirements
* JupyterLab >= 3.1
## Install
```bash
pip install jupyterlab_stata_highlight2
```
### Uninstall
```bash
pip uninstall jupyterlab_stata_highlight2
```
## 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 jupyterlab_stata_highlight2 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 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.
```bash
# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run 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 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
```
### Updating the version
To update the version, install tbump and use it to bump the version.
By default it will also create a tag.
```bash
pip install tbump
tbump <new-version>
```
## Predecessor license notices
Extension boilerplate originated in Project Jupyter's https://github.com/jupyterlab/extension-cookiecutter-js
Extension content forked from Kyle Barron's https://github.com/kylebarron/jupyterlab-stata-highlight
Please note their respective licenses.
Raw data
{
"_id": null,
"home_page": "",
"name": "jupyterlab-stata-highlight2",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "Jupyter,JupyterLab,JupyterLab3",
"author": "",
"author_email": "Tim Huegerich <hugetim@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/52/29/ffd080e146fdfdcd5192f2bf7056122bb8ebac1e04c852dca2fb33082bb1/jupyterlab_stata_highlight2-0.1.1.tar.gz",
"platform": null,
"description": "# jupyterlab_stata_highlight2\n\n\n\nJupyterLab extension for Stata syntax highlighting similar to the Stata IDE's.\n\n## Requirements\n\n* JupyterLab >= 3.1\n\n## Install\n\n```bash\npip install jupyterlab_stata_highlight2\n```\n\n### Uninstall\n\n```bash\npip uninstall jupyterlab_stata_highlight2\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 jupyterlab_stata_highlight2 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 run 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 run 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 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:\n\n```bash\njupyter lab build --minimize=False\n```\n\n### Updating the version\n\nTo update the version, install tbump and use it to bump the version.\nBy default it will also create a tag.\n\n```bash\npip install tbump\ntbump <new-version>\n```\n\n## Predecessor license notices\nExtension boilerplate originated in Project Jupyter's https://github.com/jupyterlab/extension-cookiecutter-js\nExtension content forked from Kyle Barron's https://github.com/kylebarron/jupyterlab-stata-highlight\nPlease note their respective licenses.\n",
"bugtrack_url": null,
"license": " The MIT License (MIT) Copyright (c) 2022, Tim Huegerich Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "JupyterLab extension for Stata syntax highlighting similar to the Stata IDE's.",
"version": "0.1.1",
"split_keywords": [
"jupyter",
"jupyterlab",
"jupyterlab3"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "04c1e50c109f90263fd670e4517972c725c062142735cdeff45f9aeea6ca6d01",
"md5": "3833044a85e57bfaff08372d6e7447d0",
"sha256": "992f5e1499293d89da80a5b6ab38e071094ff4bfb155b4501ba1d96ee7c426f2"
},
"downloads": -1,
"filename": "jupyterlab_stata_highlight2-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3833044a85e57bfaff08372d6e7447d0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 36176,
"upload_time": "2023-01-25T13:30:40",
"upload_time_iso_8601": "2023-01-25T13:30:40.837174Z",
"url": "https://files.pythonhosted.org/packages/04/c1/e50c109f90263fd670e4517972c725c062142735cdeff45f9aeea6ca6d01/jupyterlab_stata_highlight2-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5229ffd080e146fdfdcd5192f2bf7056122bb8ebac1e04c852dca2fb33082bb1",
"md5": "0db1e102a6ae8d13b9b4f79c4c6f5569",
"sha256": "d18efdcfa002b016228f37efd4fa2943d62379f6daef2b075388edc8f17750f4"
},
"downloads": -1,
"filename": "jupyterlab_stata_highlight2-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "0db1e102a6ae8d13b9b4f79c4c6f5569",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 318761,
"upload_time": "2023-01-25T13:30:46",
"upload_time_iso_8601": "2023-01-25T13:30:46.022265Z",
"url": "https://files.pythonhosted.org/packages/52/29/ffd080e146fdfdcd5192f2bf7056122bb8ebac1e04c852dca2fb33082bb1/jupyterlab_stata_highlight2-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-25 13:30:46",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "jupyterlab-stata-highlight2"
}
