# nbdev-project


<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->

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

``` sh
# 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](https://github.com/majarall/nbdev-project):

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

or from [conda](https://anaconda.org/majarall/nbdev-project)

``` sh
$ conda install -c majarall nbdev_project
```

or from [pypi](https://pypi.org/project/nbdev-project/)

``` sh
$ pip install nbdev_project
```

### Documentation

Documentation can be found hosted on this GitHub
[repository](https://github.com/majarall/nbdev-project)’s
[pages](https://majarall.github.io/nbdev-project/). Additionally you can
find package manager specific guidelines on
[conda](https://anaconda.org/majarall/nbdev-project) and
[pypi](https://pypi.org/project/nbdev-project/) respectively.

## How to use

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

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

    10♥