chrphb-friends 0.0.1

Repository Code to Manage My Friends

chrphb-friends

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

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

# 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:

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

or from conda

$ conda install -c chrphb chrphb_friends

or from pypi

$ pip install chrphb_friends

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

2

from chrphb_friends.core import Friend

f1 = Friend('1','doo', 'john', '[e-mail]', '00000000', 'linkedin', 'twitter')
f1

Friend(id='1', family_name='doo', first_name='john', email='[e-mail]', phone='00000000', linkedin='linkedin', twitter='twitter')

from chrphb_friends.core import Repository

repo = Repository('friends_v1.db')
repo

Repository SQLLite at friends_v1.db

repo.add('doo', 'john', '[e-mail]', '0000000000', 'linkedin', 'twitter')

Now, let’s retrieve my friends:

repo.friends()

[Friend(id='e4977cf1-cc3c-4425-83c1-e25b98891896', family_name='doo', first_name='john', email='[e-mail]', phone='0000000000', linkedin='linkedin', twitter='twitter'),
 Friend(id='868dff57-6db3-43e6-a10f-d89353a833b2', family_name='doo', first_name='john', email='[e-mail]', phone='0000000000', linkedin='linkedin', twitter='twitter')]