Thread by @TheZachMueller

lib2nbdev has been on my mind for months now, and finally it exists! What's the biggest struggle with @fastdotai's #nbdev? Using it on existing projects. This tool aims to fix that.

But how does it work?

novetta.github.io/lib2nbdev/

https://twitter.com/Novettasol/status/1379508120028856322

With a simple bash command: `convert_lib`.

You are then guided through the process of setting up nbdev's `setting.ini` file and afterwards all of your existing code will be converted directly into fully functional notebooks!

But wait, don't you just throw it all into one big cell?

NO! Instead lib2nbdev will determine what should be private or public, what's an import, and what particular cell tag it should be generated with, such as below which has both private and public tags:

Each generated notebook is given a template heading for you to modify (as only YOU know what to title each notebook!) But from there it's as simple as adding in your tests, writing your documentation, and then fully working in the #nbdev pipeline!

You can also optionally include @fastdotai's fancy Github CI as well, so you won't miss out on the automated testing framework from your notebooks.

Currently there is a pip release, with conda coming soon

(so pip install lib2nbdev)

A big thank you to everyone at @Novettasol for letting me go down and explore this rabbit hole, I am very appreciative of the opportunity to do this at work.

I hope folks will find this tool extremely useful for getting teams up to speed with utilizing nbdev!

And of course to @jeremyphoward and @HamelHusain for giving us nbdev in the first place and answering all my questions as I was developing this 😁