# JLAB Dev
> Develop python packages using jupyterlab.
This library allows you to develop regular python packages while writing your code in jupyterlab.
You can create notebooks to develop your code and in these notebooks, simply annotate your cells with `#export` if you want them to be put in the library. (A notebook must be marked for conversion with `#convert` in the first code cell.)
Other cells will be used as examples in your doc (together with the markdown of your notebook) unless marked with `#hide`.
Of course JLAB Dev itself is completly implemented as a notebook in jupyterlab (see [here](jlabdev/convert.ipynb)).
## Installation
It is as simple as a pip install.
```bash
# For stable version
pip install jlabdev
# or for bleeding edge
pip install git+https://github.com/penguinmenac3/jlabdev.git
```
## Usage
### Basics
Simply create your notebooks and add a code cell with `#convert` as the first cell and annotate all cells you want to export with `#export`.
Now you can compile your notebook into python and markdown doc by saving it and then running these commands at the root of your project folder:
```bash
nb2py # Creates python files next to the notebooks
nb2md # Creates markdown doc in docs
```
When you edit your python file (e.g. refactoring) and want to update the notebook from the python file.
```bash
py2nb
```
# Documentation
Documentation can be found in [docs](docs/README.md) it will be automatically generated there. The README.md is an overview over all packages availible.
# License
The MIT License (MIT)
Copyright (c) 2020 Michael Fuerst
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.
Raw data
{
"_id": null,
"home_page": "https://github.com/penguinmenac3/jlabdev",
"name": "jlabdev",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Michael Fuerst",
"author_email": "mail@michaelfuerst.de",
"download_url": "https://files.pythonhosted.org/packages/ac/78/e0b5664ce195146248d1f537bc11c3fa7673bf5aafac80c72c4942ea31ca/jlabdev-20230119.tar.gz",
"platform": null,
"description": "# JLAB Dev\n\n> Develop python packages using jupyterlab.\n\nThis library allows you to develop regular python packages while writing your code in jupyterlab.\nYou can create notebooks to develop your code and in these notebooks, simply annotate your cells with `#export` if you want them to be put in the library. (A notebook must be marked for conversion with `#convert` in the first code cell.)\nOther cells will be used as examples in your doc (together with the markdown of your notebook) unless marked with `#hide`.\n\n\n\nOf course JLAB Dev itself is completly implemented as a notebook in jupyterlab (see [here](jlabdev/convert.ipynb)).\n\n## Installation\n\nIt is as simple as a pip install.\n\n```bash\n# For stable version\npip install jlabdev\n\n# or for bleeding edge\npip install git+https://github.com/penguinmenac3/jlabdev.git\n```\n\n## Usage\n\n### Basics\n\nSimply create your notebooks and add a code cell with `#convert` as the first cell and annotate all cells you want to export with `#export`.\n\nNow you can compile your notebook into python and markdown doc by saving it and then running these commands at the root of your project folder:\n\n```bash\nnb2py # Creates python files next to the notebooks\nnb2md # Creates markdown doc in docs\n```\n\nWhen you edit your python file (e.g. refactoring) and want to update the notebook from the python file.\n\n```bash\npy2nb\n```\n\n# Documentation\n\nDocumentation can be found in [docs](docs/README.md) it will be automatically generated there. The README.md is an overview over all packages availible.\n\n\n# License\n\nThe MIT License (MIT)\n\nCopyright (c) 2020 Michael Fuerst\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A small simple tool to develop python from jupyterlab notebooks.",
"version": "20230119",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "68f77235bc4d17c9317697ca8bd251868df4c24b011e7ef64f0b9cc3d1c46742",
"md5": "adbe4cdf11e58fc89d8e22df51992bb2",
"sha256": "75cf75f2dde7ed7d2ae3ae1dde02b40c93cd5a7df24532198b89f0fff678afdb"
},
"downloads": -1,
"filename": "jlabdev-20230119-py3-none-any.whl",
"has_sig": false,
"md5_digest": "adbe4cdf11e58fc89d8e22df51992bb2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 10539,
"upload_time": "2023-02-02T22:20:32",
"upload_time_iso_8601": "2023-02-02T22:20:32.235007Z",
"url": "https://files.pythonhosted.org/packages/68/f7/7235bc4d17c9317697ca8bd251868df4c24b011e7ef64f0b9cc3d1c46742/jlabdev-20230119-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ac78e0b5664ce195146248d1f537bc11c3fa7673bf5aafac80c72c4942ea31ca",
"md5": "9359d552028bb97b52825899670ec6d5",
"sha256": "4f0e2b83e178ad360e312ce37e4652b18126003331264d4051603b7282bfe1c9"
},
"downloads": -1,
"filename": "jlabdev-20230119.tar.gz",
"has_sig": false,
"md5_digest": "9359d552028bb97b52825899670ec6d5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9942,
"upload_time": "2023-02-02T22:20:33",
"upload_time_iso_8601": "2023-02-02T22:20:33.618304Z",
"url": "https://files.pythonhosted.org/packages/ac/78/e0b5664ce195146248d1f537bc11c3fa7673bf5aafac80c72c4942ea31ca/jlabdev-20230119.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-02 22:20:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "penguinmenac3",
"github_project": "jlabdev",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "jlabdev"
}
JSON
