# 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",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "Jupyter, Widgets, IPython",
"author": "boyuai",
"author_email": null,
"download_url": null,
"platform": "Linux",
"description": "# ipybbycell\n\n[](https://github.com/boyuai/ipybbycell/actions)\n[](https://codecov.io/gh/boyuai/ipybbycell)\n\nBBY Cell Extension\n\n## Installation\n\nYou can install using `pip` :\n\n```bash\ngit clone git@github.com:boyuai/ipybbycell.git\ncd ipybbycell\npip install \".[test, examples]\"\n```\n\nIf you are using Jupyter Notebook 5.2 or earlier, you may also need to enable\nthe nbextension:\n\n```bash\njupyter nbextension enable --py [--sys-prefix|--user|--system] ipybbycell\n```\n\n## Development Installation\n\nCreate a dev environment:\n\n```bash\ngit clone git@github.com:boyuai/ipybbycell.git\ncd ipybbycell\npython3 -m venv venv\nsource venv/bin/activate\n```\n\nInstall the python. This will also build the TS package.\n\n```bash\npip install -e \".[test, examples]\"\n```\n\nWhen developing your extensions, you need to manually enable your extensions with the\nnotebook / lab frontend.\n\nFor classic notebook, you need to run:\n\n```\njupyter nbextension install --sys-prefix --symlink --overwrite --py ipybbycell-extension\njupyter nbextension enable --sys-prefix --py ipybbycell-extension\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\n#### Typescript:\n\n```bash\n# Watch the source directory in one terminal, automatically rebuilding when needed\nyarn run watch\n# Run Jupyter Notebook in another terminal\njupyter notebook\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:\n\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## Releasing your initial packages:\n\n* Add tests\n* Ensure tests pass locally and on CI. Check that the coverage is reasonable.\n* Make a release commit, where you remove the `, 'dev'` entry in `_version.py`.\n<!-- * Update the version in `package.json`\n* Relase the npm packages:\n \n\n```bash\n npm login\n npm publish\n ``` -->\n\n* Bundle the python package: `python setup.py sdist bdist_wheel`\n* Publish the package to PyPI:\n\n```bash\n python setup.py sdist bdist_wheel\n pip install twine\n twine upload dist/ipybbycell-extension*\n ```\n\n<!-- * Tag the release commit (`git tag <python package version identifier>`)\n* Update the version in `_version.py`, and put it back to dev (e.g. 0.1.0 -> 0.2.0.dev).\n Update the versions of the npm packages (without publishing).\n* Commit the changes.\n* `git push` and `git push --tags`. -->\n\n\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "BBY Cell Extension",
"version": "0.4.0",
"project_urls": {
"Homepage": "https://github.com/boyuai/ipybbycell"
},
"split_keywords": [
"jupyter",
" widgets",
" ipython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "047fc724c72bf1821075c80c6bc98118d88aee0467ffa500ee20f925e4d8a6c9",
"md5": "d871523da1b5ae28d086dfa8faa39b97",
"sha256": "4bf96acfd76f8558af2469b29c0062dc94791d7ceaacd36519ac5e38da9efa63"
},
"downloads": -1,
"filename": "ipybbycell-0.4.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "d871523da1b5ae28d086dfa8faa39b97",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.6",
"size": 934608,
"upload_time": "2024-08-14T09:15:49",
"upload_time_iso_8601": "2024-08-14T09:15:49.469915Z",
"url": "https://files.pythonhosted.org/packages/04/7f/c724c72bf1821075c80c6bc98118d88aee0467ffa500ee20f925e4d8a6c9/ipybbycell-0.4.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-14 09:15:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "boyuai",
"github_project": "ipybbycell",
"github_not_found": true,
"lcname": "ipybbycell"
}
JSON
