learn-nbdev

learning nbdev

This file will become your README and also the index of your documentation.

Developer Guide

If you are new to using nbdev here are some useful pointers to get you started.

Install learn_nbdev in Development mode

# make sure learn_nbdev package is installed in development mode
$ pip install -e .

# make changes under nbs/ directory
# ...

# compile to have changes apply to learn_nbdev
$ nbdev_prepare

Usage

Installation

Install latest from the GitHub repository:

$ pip install git+https://github.com/mettafore/learn-nbdev.git

or from conda

$ conda install -c mettafore learn_nbdev

or from pypi

$ pip install learn_nbdev

Documentation

Documentation can be found hosted on this GitHub repository’s pages. Additionally you can find package manager specific guidelines on conda and pypi respectively.

How to use

Fill me in please! Don’t forget code examples:

1+1

from learn_nbdev.cool_lib import foo, go_duckies_yourself

go_duckies_yourself("morris")

'go duckies yourself morris'

foo()

foo