nbdev-project

nbdev project example

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 nbdev_project in Development mode

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

# make changes under nbs/ directory
# ...

# compile to have changes apply to nbdev_project
$ nbdev_prepare

Usage

Installation

Install latest from the GitHub repository:

$ pip install git+https://github.com/majarall/nbdev-project.git

or from conda

$ conda install -c majarall nbdev_project

or from pypi

$ pip install nbdev_project

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

This lib provides a Card class you can use to create, display and compare playing cards:

c = Card(suit=1, rank=10)
print(c)

10♥