A small library for converting existing libraries and projects to nbdev
Project description
lib2nbdev
An all-inclusive package for converting your existing libraries and projects into
nbdev
ones. Developed by Novetta.
nbdev 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!).
lib2nbdev
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 and the related nbdev documentation
Install
pip install lib2nbdev
How to use
From your project directory (in bash), simply run:
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:
If you wish to use this library you should either:
- Use Windows Subsystem for Linux (WSL2)
- Use the Python3 interpreter in Windows:
python3
from lib2nbdev.convert import convert_lib; convert_lib()
Important Notice:
This is a one-time conversion, this does not allow for repeated python -> notebook conversions.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for lib2nbdev-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dd45b5a85ab0e7c173135a24d580f18c1d95ad0baf73f1a395f0822eca4a8185 |
|
MD5 | ccaa1da64ad4be10cc87cad13cf9203d |
|
BLAKE2b-256 | e13896bcaa3df9958f5e1f551b704c892191e02166baf58e62babe00d16be37e |