| Name | lmkapp JSON |
| Version |
1.2.0
JSON |
| download |
| home_page | None |
| Summary | Stop watching your code run |
| upload_time | 2024-07-22 08:53:42 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | Copyright 2023 Cameron Feenstra 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 |
ipython
jupyter
widgets
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# LMK Python Client
<!-- [](https://travis-ci.org/cfeenstra67/lmk)
[](https://codecov.io/gh/cfeenstra67/lmk) -->
## Installation
You can install using `pip`:
```bash
pip install 'lmkapp[cli,jupyter]'
```
If you are using Jupyter Notebook 5.2 or earlier, you may also need to enable
the nbextension:
```bash
jupyter nbextension enable --py [--sys-prefix|--user|--system] lmk
```
## Development Installation
Create a dev environment:
```bash
python -m venv venv
```
Install the python package. This will also build the TS package.
```bash
pip install -e ".[dev,jupyter,cli,docs,types]"
```
## Docs Development
To build the docs, run:
```bash
pnpm build:docs
```
To run a development server, run:
```bash
pnpm dev:docs
```
## Jupyter Development
When developing your extensions, you need to manually enable your extensions with the
notebook / lab frontend. For lab, this is done by the command:
```bash
jupyter labextension develop --overwrite .
pnpm build
```
For classic notebook, you need to run:
```bash
jupyter nbextension install --sys-prefix --symlink --overwrite --py lmk
jupyter nbextension enable --sys-prefix --py lmk
```
Note that the `--symlink` flag doesn't work on Windows, so you will here have to run
the `install` command every time that you rebuild your extension. For certain installations
you might also need another flag instead of `--sys-prefix`, but we won't cover the meaning
of those flags here.
### How to see your changes
#### Typescript:
If you use JupyterLab to develop then 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 widget.
```bash
# Watch the source directory in one terminal, automatically rebuilding when needed
pnpm watch
# Run JupyterLab in another terminal
jupyter lab
```
After a change wait for the build to finish and then refresh your browser and the changes should take effect.
#### Python:
If you make a change to the python code then you will need to restart the notebook kernel to have it take effect.
## Updating the version
To update the version, install bump2version and use it to bump the version.
By default it will also create a tag.
```bash
pip install bump2version
bumpversion <pre|prekind|patch|minor|major>
```
## Publishing - PyPI
Build the python package:
```bash
pnpm build:python
```
Check the built assets:
```bash
pnpm pypi-check
```
Publish to the test index:
```bash
pnpm pypi-upload-test
```
Install from test index:
```bash
pip install --extra-index-url https://test.pypi.org/simple/ 'lmkapp[jupyter]==<version>'
```
Publish to real index:
```bash
pnpm pypi-upload
```
## Publishing - NPM
Build the npm package:
```bash
pnpm build:publish
```
Publish the npm package:
```bash
pnpm npm-publish
```
Raw data
{
"_id": null,
"home_page": null,
"name": "lmkapp",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "IPython, Jupyter, Widgets",
"author": null,
"author_email": "Cam Feenstra <me@camfeenstra.com>",
"download_url": "https://files.pythonhosted.org/packages/60/34/ec987dace2e0191f69b4cbc1a0a651ba5e90f7f2f15143c98b69b06aae2c/lmkapp-1.2.0.tar.gz",
"platform": null,
"description": "\n# LMK Python Client\n\n<!-- [](https://travis-ci.org/cfeenstra67/lmk)\n[](https://codecov.io/gh/cfeenstra67/lmk) -->\n\n## Installation\n\nYou can install using `pip`:\n\n```bash\npip install 'lmkapp[cli,jupyter]'\n```\n\nIf you are using Jupyter Notebook 5.2 or earlier, you may also need to enable\nthe nbextension:\n```bash\njupyter nbextension enable --py [--sys-prefix|--user|--system] lmk\n```\n\n## Development Installation\n\nCreate a dev environment:\n```bash\npython -m venv venv\n```\n\nInstall the python package. This will also build the TS package.\n```bash\npip install -e \".[dev,jupyter,cli,docs,types]\"\n```\n\n## Docs Development\n\nTo build the docs, run:\n```bash\npnpm build:docs\n```\nTo run a development server, run:\n```bash\npnpm dev:docs\n```\n\n## Jupyter Development\n\nWhen developing your extensions, you need to manually enable your extensions with the\nnotebook / lab frontend. For lab, this is done by the command:\n\n```bash\njupyter labextension develop --overwrite .\npnpm build\n```\n\nFor classic notebook, you need to run:\n\n```bash\njupyter nbextension install --sys-prefix --symlink --overwrite --py lmk\njupyter nbextension enable --sys-prefix --py lmk\n```\n\nNote that the `--symlink` flag doesn't work on Windows, so you will here have to run\nthe `install` command every time that you rebuild your extension. For certain installations\nyou might also need another flag instead of `--sys-prefix`, but we won't cover the meaning\nof those flags here.\n\n### How to see your changes\n#### Typescript:\nIf you use JupyterLab to develop then you can watch the source directory and run JupyterLab at the same time in different\nterminals to watch for changes in the extension's source and automatically rebuild the widget.\n\n```bash\n# Watch the source directory in one terminal, automatically rebuilding when needed\npnpm watch\n# Run JupyterLab in another terminal\njupyter lab\n```\n\nAfter a change wait for the build to finish and then refresh your browser and the changes should take effect.\n\n#### Python:\nIf you make a change to the python code then you will need to restart the notebook kernel to have it take effect.\n\n## Updating the version\n\nTo update the version, install bump2version and use it to bump the version.\nBy default it will also create a tag.\n\n```bash\npip install bump2version\nbumpversion <pre|prekind|patch|minor|major>\n```\n\n## Publishing - PyPI\n\nBuild the python package:\n```bash\npnpm build:python\n```\n\nCheck the built assets:\n```bash\npnpm pypi-check\n```\n\nPublish to the test index:\n```bash\npnpm pypi-upload-test\n```\n\nInstall from test index:\n```bash\npip install --extra-index-url https://test.pypi.org/simple/ 'lmkapp[jupyter]==<version>'\n```\n\nPublish to real index:\n```bash\npnpm pypi-upload\n```\n\n## Publishing - NPM\n\nBuild the npm package:\n```bash\npnpm build:publish\n```\n\nPublish the npm package:\n```bash\npnpm npm-publish\n```\n",
"bugtrack_url": null,
"license": "Copyright 2023 Cameron Feenstra Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \u201cSoftware\u201d), 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 \u201cAS IS\u201d, 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": "Stop watching your code run",
"version": "1.2.0",
"project_urls": {
"Homepage": "https://github.com/lmkapp/lmk"
},
"split_keywords": [
"ipython",
" jupyter",
" widgets"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5c74035e65e9d54c064fb930fa48038c0262547343637aab3be6af4e81aa134f",
"md5": "116d8bdd9998dbb204cfb935a7761a27",
"sha256": "968662cbf190a8123b6abd0bfaaeb911ff39cf78f8596062d00b3b2061775a24"
},
"downloads": -1,
"filename": "lmkapp-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "116d8bdd9998dbb204cfb935a7761a27",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 2504040,
"upload_time": "2024-07-22T08:53:40",
"upload_time_iso_8601": "2024-07-22T08:53:40.522354Z",
"url": "https://files.pythonhosted.org/packages/5c/74/035e65e9d54c064fb930fa48038c0262547343637aab3be6af4e81aa134f/lmkapp-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6034ec987dace2e0191f69b4cbc1a0a651ba5e90f7f2f15143c98b69b06aae2c",
"md5": "38e75a7d55a6c58b119c1b1cb8bba7bd",
"sha256": "89fea2228634bffca48f155aa160b0e150e189202c9a7557d2d739ceadeba5e8"
},
"downloads": -1,
"filename": "lmkapp-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "38e75a7d55a6c58b119c1b1cb8bba7bd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 1274552,
"upload_time": "2024-07-22T08:53:42",
"upload_time_iso_8601": "2024-07-22T08:53:42.094661Z",
"url": "https://files.pythonhosted.org/packages/60/34/ec987dace2e0191f69b4cbc1a0a651ba5e90f7f2f15143c98b69b06aae2c/lmkapp-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-22 08:53:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lmkapp",
"github_project": "lmk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "lmkapp"
}
