| Name | jupyterlab-osmd JSON |
| Version |
0.1.2
JSON |
| download |
| home_page | None |
| Summary | JupyterLab mime renderer for OpenSheetMusicDisplay |
| upload_time | 2024-11-19 17:47:51 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2024 innovationOUtside 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
jupyterlab-extension
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# jupyterlab_osmd
First attempt at JupyterLab mime renderer for MusicXML (`.muscixml` / minme type `application/vnd.recordare.musicxml` ) using [OpenSheetMusicDisplay](https://github.com/opensheetmusicdisplay/opensheetmusicdisplay/)
*Works a bit...*
`pip install jupyterlab-osmd`
Double click on a `.musicxml` file in the JupyterLab file browser and it should render using OSMD.
Python API:
```python
# Minimally
def OSMD(data=''):
bundle = {}
bundle['application/vnd.recordare.musicxml'] = data
display(bundle, raw=True)
# A far more elaborate version available as:
#from jupyterlab_osmd import OSMD
# This supports:
# - MusicXML string
# - path to .musicxml or compressed .mxl file
# - URL to musicxml file
with open("Downloads/xmlsamples/Telemann.musicxml", 'r') as f:
d = f.read()
OSMD(d)
```
## Requirements
- JupyterLab >= 4.0.0
## Install
To install the extension, execute:
```bash
pip install jupyterlab_osmd
```
## Uninstall
To remove the extension, execute:
```bash
pip uninstall jupyterlab_osmd
```
## 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_osmd directory
# Install package in development mode
pip install -e "."
# Install required node packages
npm install --save opensheetmusicdisplay uuid
# 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 jupyterlab_osmd
```
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 `jupyterlab-osmd` within that folder.
### Testing the extension
#### Frontend tests
This extension is using [Jest](https://jestjs.io/) for JavaScript code testing.
To execute them, execute:
```sh
jlpm
jlpm test
```
#### Integration tests
This extension uses [Playwright](https://playwright.dev/docs/intro) for the integration tests (aka user level tests).
More precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab.
More information are provided within the [ui-tests](./ui-tests/README.md) README.
### Packaging the extension
See [RELEASE](RELEASE.md)
Raw data
{
"_id": null,
"home_page": null,
"name": "jupyterlab-osmd",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "jupyter, jupyterlab, jupyterlab-extension",
"author": null,
"author_email": "Tony Hirst <tony.hirst@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/f8/bb/b43d7caa07eebb11bed27a904f0e3a0359ecb1fbadd692fd774c9909976e/jupyterlab_osmd-0.1.2.tar.gz",
"platform": null,
"description": "# jupyterlab_osmd\n\nFirst attempt at JupyterLab mime renderer for MusicXML (`.muscixml` / minme type `application/vnd.recordare.musicxml` ) using [OpenSheetMusicDisplay](https://github.com/opensheetmusicdisplay/opensheetmusicdisplay/)\n\n*Works a bit...*\n\n\n\n`pip install jupyterlab-osmd`\n\nDouble click on a `.musicxml` file in the JupyterLab file browser and it should render using OSMD.\n\nPython API:\n\n```python\n# Minimally\ndef OSMD(data=''):\n bundle = {}\n bundle['application/vnd.recordare.musicxml'] = data\n display(bundle, raw=True)\n\n# A far more elaborate version available as:\n#from jupyterlab_osmd import OSMD\n# This supports:\n# - MusicXML string\n# - path to .musicxml or compressed .mxl file\n# - URL to musicxml file\n\nwith open(\"Downloads/xmlsamples/Telemann.musicxml\", 'r') as f:\n d = f.read()\n\nOSMD(d)\n```\n\n## Requirements\n\n- JupyterLab >= 4.0.0\n\n## Install\n\nTo install the extension, execute:\n\n```bash\npip install jupyterlab_osmd\n```\n\n## Uninstall\n\nTo remove the extension, execute:\n\n```bash\npip uninstall jupyterlab_osmd\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_osmd directory\n# Install package in development mode\npip install -e \".\"\n# Install required node packages\nnpm install --save opensheetmusicdisplay uuid\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 jupyterlab_osmd\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 `jupyterlab-osmd` within that folder.\n\n### Testing the extension\n\n#### Frontend tests\n\nThis extension is using [Jest](https://jestjs.io/) for JavaScript code testing.\n\nTo execute them, execute:\n\n```sh\njlpm\njlpm test\n```\n\n#### Integration tests\n\nThis extension uses [Playwright](https://playwright.dev/docs/intro) for the integration tests (aka user level tests).\nMore precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab.\n\nMore information are provided within the [ui-tests](./ui-tests/README.md) README.\n\n### Packaging the extension\n\nSee [RELEASE](RELEASE.md)\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 innovationOUtside 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 mime renderer for OpenSheetMusicDisplay",
"version": "0.1.2",
"project_urls": {
"Bug Tracker": "https://github.com/innovationOUtside/jupyterlab-osmd/issues",
"Homepage": "https://github.com/innovationOUtside/jupyterlab-osmd",
"Repository": "https://github.com/innovationOUtside/jupyterlab-osmd.git"
},
"split_keywords": [
"jupyter",
" jupyterlab",
" jupyterlab-extension"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "947cc32bb2bee5dba2a1184a81e2d87adc9fb2665b2ceae2f61e5abff50a13b4",
"md5": "838b29fd85a3a813b529c44a42f1fb41",
"sha256": "1c59bf20c3a42385adbbe3d8647a0e949a1db63a081f3671771dd80d36c73ad0"
},
"downloads": -1,
"filename": "jupyterlab_osmd-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "838b29fd85a3a813b529c44a42f1fb41",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 1378014,
"upload_time": "2024-11-19T17:47:49",
"upload_time_iso_8601": "2024-11-19T17:47:49.655351Z",
"url": "https://files.pythonhosted.org/packages/94/7c/c32bb2bee5dba2a1184a81e2d87adc9fb2665b2ceae2f61e5abff50a13b4/jupyterlab_osmd-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f8bbb43d7caa07eebb11bed27a904f0e3a0359ecb1fbadd692fd774c9909976e",
"md5": "fb582ac4137eb27215a0fc96c772438c",
"sha256": "a568b72cf72364ab3ea01ddad5ad7ac2a5f14a79c368f8060ca7a8ee5c0771e7"
},
"downloads": -1,
"filename": "jupyterlab_osmd-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "fb582ac4137eb27215a0fc96c772438c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 1271889,
"upload_time": "2024-11-19T17:47:51",
"upload_time_iso_8601": "2024-11-19T17:47:51.563474Z",
"url": "https://files.pythonhosted.org/packages/f8/bb/b43d7caa07eebb11bed27a904f0e3a0359ecb1fbadd692fd774c9909976e/jupyterlab_osmd-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-19 17:47:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "innovationOUtside",
"github_project": "jupyterlab-osmd",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "jupyterlab-osmd"
}
