nbdev-hello-world

Hello world with nbdev

I want to use nbdev for a project but I am not sure what type of project I want to create yet.

This repo was create for the tutorial.

I had a mostly positive experience. There were a few bumps in the road but I made it.

Developer Guide

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

Install nbdev_hello_world in Development mode

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

# make changes under nbs/ directory
# ...

# compile to have changes apply to nbdev_hello_world
$ nbdev_prepare

Usage

Installation

Install latest from the GitHub repository:

$ pip install git+https://github.com/eitanlees/nbdev-hello-world.git

or from conda

$ conda install -c eitanlees nbdev_hello_world

or from pypi

$ pip install nbdev_hello_world

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

say_hello('Eitan')

'Hello Eitan!'