Metadata-Version: 2.1
Name: chrphb-friends
Version: 0.0.1
Summary: Repository Code to Manage My Friends
Home-page: https://github.com/chrphb/chrphb-friends
Author: Christophe Beaucé
Author-email: chris@chrphb.com
License: Apache Software License 2.0
Keywords: nbdev jupyter notebook python
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: License :: OSI Approved :: Apache Software License
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: dev

# chrphb-friends


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

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

``` 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)

``` 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
```

    2

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

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

    Friend(id='1', family_name='doo', first_name='john', email='john@doo.com', phone='00000000', linkedin='linkedin', twitter='twitter')

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

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

    Repository SQLLite at friends_v1.db

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

Now, let’s retrieve my friends:

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

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