lib2nbdev2
================
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
[nbdev](nbdev.fast.ai) is a fantastic workflow aimed at centralizing
documentation, testing, and source code generation all out of one place:
Jupyter Notebooks. However, what if you already have an existing
project? As it stands the only way to convert your library over is
through manual tasks (which can take \> 30 hrs!).
`lib2nbdev2` is the solution!
Instead, we can perform a one-time conversion on any existing library.
During the conversion process the library will help you generate a
proper `settings.ini` configuration file for your project. However you
can also generate your own `settings.ini` and put it in your project’s
core directory, such as:
- `lib2nbdev`
- **`settings.ini`**
- `lib2nbdev`
- `convert.py`
For generating a valid `settings.ini`, see an example
[here](https://github.com/fastai/nbdev_template/blob/master/settings.ini)
and the related nbdev
[documentation](https://nbdev.fast.ai/tutorial.html#Edit-settings.ini)
## Install
`pip install lib2nbdev2`
## How to use
From your project directory (in bash), simply run:
``` bash
convert_lib
```
And it will automatically generate the notebooks needed, as well as
privatizing any functions that may need it (anything preceding with a
`_` in the name) where they shouldn’t show in the generated
documentation.
Afterwards you have a fully-functional `nbdev` library, and can make use
of all its goodies!
### Note for Windows Users:
Not tested on windows
## Important Notice:
**This is a one-time conversion, this does not allow for repeated python
-\> notebook conversions.**
Raw data
{
"_id": null,
"home_page": "https://github.com/dmitryhits/lib2nbdev2/tree/main/",
"name": "lib2nbdev2",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "nbdev lib2nbdev2 fastai fastcore",
"author": "Dmitry Hits",
"author_email": "dmitry.hits@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/be/1d/2710c882fc3b71ca67727724ec6233b466f9c7f0ed2c3cfaa9bf794b14e3/lib2nbdev2-0.0.3.tar.gz",
"platform": null,
"description": "lib2nbdev2\n================\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\n[nbdev](nbdev.fast.ai) is a fantastic workflow aimed at centralizing\ndocumentation, testing, and source code generation all out of one place:\nJupyter Notebooks. However, what if you already have an existing\nproject? As it stands the only way to convert your library over is\nthrough manual tasks (which can take \\> 30 hrs!).\n\n`lib2nbdev2` is the solution!\n\nInstead, we can perform a one-time conversion on any existing library.\nDuring the conversion process the library will help you generate a\nproper `settings.ini` configuration file for your project. However you\ncan also generate your own `settings.ini` and put it in your project\u2019s\ncore directory, such as:\n\n- `lib2nbdev`\n - **`settings.ini`**\n - `lib2nbdev`\n - `convert.py`\n\nFor generating a valid `settings.ini`, see an example\n[here](https://github.com/fastai/nbdev_template/blob/master/settings.ini)\nand the related nbdev\n[documentation](https://nbdev.fast.ai/tutorial.html#Edit-settings.ini)\n\n## Install\n\n`pip install lib2nbdev2`\n\n## How to use\n\nFrom your project directory (in bash), simply run:\n\n``` bash\nconvert_lib\n```\n\nAnd it will automatically generate the notebooks needed, as well as\nprivatizing any functions that may need it (anything preceding with a\n`_` in the name) where they shouldn\u2019t show in the generated\ndocumentation.\n\nAfterwards you have a fully-functional `nbdev` library, and can make use\nof all its goodies!\n\n### Note for Windows Users:\n\nNot tested on windows\n\n## Important Notice:\n\n**This is a one-time conversion, this does not allow for repeated python\n-\\> notebook conversions.**\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "A small library for converting existing libraries and projects to nbdev",
"version": "0.0.3",
"split_keywords": [
"nbdev",
"lib2nbdev2",
"fastai",
"fastcore"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b42a6f01d3ed32bb85305e12ff0a72c05a9710c4ba81c6f1894d9a912b8a563a",
"md5": "65a756f9b5bdd7f8d894acc59bb350b2",
"sha256": "fc3c3b28d1f304e71cfc44dcc2919fe951174e46643b296eae6009a84c247f73"
},
"downloads": -1,
"filename": "lib2nbdev2-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "65a756f9b5bdd7f8d894acc59bb350b2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 13591,
"upload_time": "2023-02-10T16:02:55",
"upload_time_iso_8601": "2023-02-10T16:02:55.105237Z",
"url": "https://files.pythonhosted.org/packages/b4/2a/6f01d3ed32bb85305e12ff0a72c05a9710c4ba81c6f1894d9a912b8a563a/lib2nbdev2-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "be1d2710c882fc3b71ca67727724ec6233b466f9c7f0ed2c3cfaa9bf794b14e3",
"md5": "53e7c8c2814d800ffab3156a63208e2c",
"sha256": "1f1c9bcabd3455817736827527639f3b80d00ccd0198af4baf075eda22663cbe"
},
"downloads": -1,
"filename": "lib2nbdev2-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "53e7c8c2814d800ffab3156a63208e2c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 15423,
"upload_time": "2023-02-10T16:02:56",
"upload_time_iso_8601": "2023-02-10T16:02:56.144262Z",
"url": "https://files.pythonhosted.org/packages/be/1d/2710c882fc3b71ca67727724ec6233b466f9c7f0ed2c3cfaa9bf794b14e3/lib2nbdev2-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-10 16:02:56",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "lib2nbdev2"
}
JSON