# chrphb-friends


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

This library will enable to manage a list of friends, relatives,
contacts.

## Developer Guide

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

### Install chrphb_friends in Development mode

``` sh
# make sure chrphb_friends package is installed in development mode
$ pip install -e .

# make changes under nbs/ directory
# ...

# compile to have changes apply to chrphb_friends
$ nbdev_prepare
```

## Usage

### Installation

Install latest from the GitHub
[repository](https://github.com/chrphb/chrphb-friends):

``` sh
$ pip install git+https://github.com/chrphb/chrphb-friends.git
```

or from [conda](https://anaconda.org/chrphb/chrphb-friends) (not yet
available)

``` sh
$ conda install -c chrphb chrphb_friends
```

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

``` sh
$ pip install chrphb_friends
```

### Documentation

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

## How to use

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

``` python
1+1
```

``` python
from chrphb_friends.core import Friend
```

``` python
f1 = Friend('1','doo', 'john', 'john@doo.com', '00000000', 'linkedin', 'twitter')
f1
```

``` python
from chrphb_friends.core import Repository
```

``` python
repo = Repository('friends_v1.db')
repo
```

``` python
repo.add('doo', 'john', 'john@doo.com', '0000000000', 'linkedin', 'twitter')
```

Now, let’s retrieve my friends:

``` python
repo.friends()
```

``` python
repo.add_obj(f1)
```

Let’s remove the previous object.

``` python
repo.remove_obj(f1)
```