# ipybbycell
[](https://github.com/boyuai/ipybbycell/actions)
[](https://codecov.io/gh/boyuai/ipybbycell)
BBY Cell Extension
## Installation
You can install using `pip` :
```bash
git clone git@github.com:boyuai/ipybbycell.git
cd ipybbycell
pip install ".[test, examples]"
```
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] ipybbycell
```
## Development Installation
Create a dev environment:
```bash
git clone git@github.com:boyuai/ipybbycell.git
cd ipybbycell
python3 -m venv venv
source venv/bin/activate
```
Install the python. This will also build the TS package.
```bash
pip install -e ".[test, examples]"
```
When developing your extensions, you need to manually enable your extensions with the
notebook / lab frontend.
For classic notebook, you need to run:
```
jupyter nbextension install --sys-prefix --symlink --overwrite --py ipybbycell-extension
jupyter nbextension enable --sys-prefix --py ipybbycell-extension
```
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:
```bash
# Watch the source directory in one terminal, automatically rebuilding when needed
yarn run watch
# Run Jupyter Notebook in another terminal
jupyter notebook
```
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.
## Releasing your initial packages:
* Add tests
* Ensure tests pass locally and on CI. Check that the coverage is reasonable.
* Make a release commit, where you remove the `, 'dev'` entry in `_version.py`.
<!-- * Update the version in `package.json`
* Relase the npm packages:
```bash
npm login
npm publish
``` -->
* Bundle the python package: `python setup.py sdist bdist_wheel`
* Publish the package to PyPI:
```bash
python setup.py sdist bdist_wheel
pip install twine
twine upload dist/ipybbycell-extension*
```
<!-- * Tag the release commit (`git tag <python package version identifier>`)
* Update the version in `_version.py`, and put it back to dev (e.g. 0.1.0 -> 0.2.0.dev).
Update the versions of the npm packages (without publishing).
* Commit the changes.
* `git push` and `git push --tags`. -->
Raw data
{
"_id": null,
"home_page": "https://github.com/boyuai/ipybbycell",
"name": "ipybbycell-extension",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "Jupyter, Widgets, IPython",
"author": "boyuai",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/ad/4d/f9993bf96cd10d5e30d06a5dcaf4fdd7a4e9df188c4c9abd3ec21f258c92/ipybbycell-extension-0.3.14.tar.gz",
"platform": "Linux",
"description": "# ipybbycell\r\n\r\n[](https://github.com/boyuai/ipybbycell/actions)\r\n[](https://codecov.io/gh/boyuai/ipybbycell)\r\n\r\nBBY Cell Extension\r\n\r\n## Installation\r\n\r\nYou can install using `pip` :\r\n\r\n```bash\r\ngit clone git@github.com:boyuai/ipybbycell.git\r\ncd ipybbycell\r\npip install \".[test, examples]\"\r\n```\r\n\r\nIf you are using Jupyter Notebook 5.2 or earlier, you may also need to enable\r\nthe nbextension:\r\n\r\n```bash\r\njupyter nbextension enable --py [--sys-prefix|--user|--system] ipybbycell\r\n```\r\n\r\n## Development Installation\r\n\r\nCreate a dev environment:\r\n\r\n```bash\r\ngit clone git@github.com:boyuai/ipybbycell.git\r\ncd ipybbycell\r\npython3 -m venv venv\r\nsource venv/bin/activate\r\n```\r\n\r\nInstall the python. This will also build the TS package.\r\n\r\n```bash\r\npip install -e \".[test, examples]\"\r\n```\r\n\r\nWhen developing your extensions, you need to manually enable your extensions with the\r\nnotebook / lab frontend.\r\n\r\nFor classic notebook, you need to run:\r\n\r\n```\r\njupyter nbextension install --sys-prefix --symlink --overwrite --py ipybbycell-extension\r\njupyter nbextension enable --sys-prefix --py ipybbycell-extension\r\n```\r\n\r\nNote that the `--symlink` flag doesn't work on Windows, so you will here have to run\r\nthe `install` command every time that you rebuild your extension. For certain installations\r\nyou might also need another flag instead of `--sys-prefix` , but we won't cover the meaning\r\nof those flags here.\r\n\r\n### How to see your changes\r\n\r\n#### Typescript:\r\n\r\n```bash\r\n# Watch the source directory in one terminal, automatically rebuilding when needed\r\nyarn run watch\r\n# Run Jupyter Notebook in another terminal\r\njupyter notebook\r\n```\r\n\r\nAfter a change wait for the build to finish and then refresh your browser and the changes should take effect.\r\n\r\n#### Python:\r\n\r\nIf you make a change to the python code then you will need to restart the notebook kernel to have it take effect.\r\n\r\n## Releasing your initial packages:\r\n\r\n* Add tests\r\n* Ensure tests pass locally and on CI. Check that the coverage is reasonable.\r\n* Make a release commit, where you remove the `, 'dev'` entry in `_version.py`.\r\n<!-- * Update the version in `package.json`\r\n* Relase the npm packages:\r\n \r\n\r\n```bash\r\n npm login\r\n npm publish\r\n ``` -->\r\n\r\n* Bundle the python package: `python setup.py sdist bdist_wheel`\r\n* Publish the package to PyPI:\r\n\r\n```bash\r\n python setup.py sdist bdist_wheel\r\n pip install twine\r\n twine upload dist/ipybbycell-extension*\r\n ```\r\n\r\n<!-- * Tag the release commit (`git tag <python package version identifier>`)\r\n* Update the version in `_version.py`, and put it back to dev (e.g. 0.1.0 -> 0.2.0.dev).\r\n Update the versions of the npm packages (without publishing).\r\n* Commit the changes.\r\n* `git push` and `git push --tags`. -->\r\n\r\n\r\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "BBY Cell Extension",
"version": "0.3.14",
"project_urls": {
"Homepage": "https://github.com/boyuai/ipybbycell"
},
"split_keywords": [
"jupyter",
" widgets",
" ipython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ad4df9993bf96cd10d5e30d06a5dcaf4fdd7a4e9df188c4c9abd3ec21f258c92",
"md5": "c72598edaf5a20c482c5a9ed99158bb0",
"sha256": "9463903724e67f9d35bbf60558a0dfbd34fd442c1aeef9b3395200374f2437b3"
},
"downloads": -1,
"filename": "ipybbycell-extension-0.3.14.tar.gz",
"has_sig": false,
"md5_digest": "c72598edaf5a20c482c5a9ed99158bb0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 667659,
"upload_time": "2024-08-14T08:18:28",
"upload_time_iso_8601": "2024-08-14T08:18:28.974705Z",
"url": "https://files.pythonhosted.org/packages/ad/4d/f9993bf96cd10d5e30d06a5dcaf4fdd7a4e9df188c4c9abd3ec21f258c92/ipybbycell-extension-0.3.14.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-14 08:18:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "boyuai",
"github_project": "ipybbycell",
"github_not_found": true,
"lcname": "ipybbycell-extension"
}
JSON
