# 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')]
Raw data
{
"_id": null,
"home_page": "https://github.com/chrphb/chrphb-friends",
"name": "chrphb-friends",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "nbdev jupyter notebook python",
"author": "Christophe Beauc\u00e9",
"author_email": "chris@chrphb.com",
"download_url": "https://files.pythonhosted.org/packages/da/72/2afe7fe878f95bc0063f2566a6da3ab5fd7ae588d63a4e1a519c1c85845b/chrphb_friends-0.0.1.tar.gz",
"platform": null,
"description": "# chrphb-friends\n\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\nThis file will become your README and also the index of your\ndocumentation.\n\nThis library will enable to manage a list of friends, relatives,\ncontacts.\n\n## Developer Guide\n\nIf you are new to using `nbdev` here are some useful pointers to get you\nstarted.\n\n### Install chrphb_friends in Development mode\n\n``` sh\n# make sure chrphb_friends package is installed in development mode\n$ pip install -e .\n\n# make changes under nbs/ directory\n# ...\n\n# compile to have changes apply to chrphb_friends\n$ nbdev_prepare\n```\n\n## Usage\n\n### Installation\n\nInstall latest from the GitHub\n[repository](https://github.com/chrphb/chrphb-friends):\n\n``` sh\n$ pip install git+https://github.com/chrphb/chrphb-friends.git\n```\n\nor from [conda](https://anaconda.org/chrphb/chrphb-friends)\n\n``` sh\n$ conda install -c chrphb chrphb_friends\n```\n\nor from [pypi](https://pypi.org/project/chrphb-friends/)\n\n``` sh\n$ pip install chrphb_friends\n```\n\n### Documentation\n\nDocumentation can be found hosted on this GitHub\n[repository](https://github.com/chrphb/chrphb-friends)\u2019s\n[pages](https://chrphb.github.io/chrphb-friends/). Additionally you can\nfind package manager specific guidelines on\n[conda](https://anaconda.org/chrphb/chrphb-friends) and\n[pypi](https://pypi.org/project/chrphb-friends/) respectively.\n\n## How to use\n\nFill me in please! Don\u2019t forget code examples:\n\n``` python\n1+1\n```\n\n 2\n\n``` python\nfrom chrphb_friends.core import Friend\n```\n\n``` python\nf1 = Friend('1','doo', 'john', 'john@doo.com', '00000000', 'linkedin', 'twitter')\nf1\n```\n\n Friend(id='1', family_name='doo', first_name='john', email='john@doo.com', phone='00000000', linkedin='linkedin', twitter='twitter')\n\n``` python\nfrom chrphb_friends.core import Repository\n```\n\n``` python\nrepo = Repository('friends_v1.db')\nrepo\n```\n\n Repository SQLLite at friends_v1.db\n\n``` python\nrepo.add('doo', 'john', 'john@doo.com', '0000000000', 'linkedin', 'twitter')\n```\n\nNow, let\u2019s retrieve my friends:\n\n``` python\nrepo.friends()\n```\n\n [Friend(id='e4977cf1-cc3c-4425-83c1-e25b98891896', family_name='doo', first_name='john', email='john@doo.com', phone='0000000000', linkedin='linkedin', twitter='twitter'),\n Friend(id='868dff57-6db3-43e6-a10f-d89353a833b2', family_name='doo', first_name='john', email='john@doo.com', phone='0000000000', linkedin='linkedin', twitter='twitter')]\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "Repository Code to Manage My Friends",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/chrphb/chrphb-friends"
},
"split_keywords": [
"nbdev",
"jupyter",
"notebook",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "13aec3a25f1456604f088dfd800d12d2b219fb2f7d06a81672dacb9a25226b49",
"md5": "18e8634f8e11a6277d35a3dfb8d147bf",
"sha256": "239dab99245c3ef99dca6a42c8b6a5e08094cd7338f158677bad2fc42851c824"
},
"downloads": -1,
"filename": "chrphb_friends-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "18e8634f8e11a6277d35a3dfb8d147bf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 8260,
"upload_time": "2025-01-19T17:11:33",
"upload_time_iso_8601": "2025-01-19T17:11:33.372862Z",
"url": "https://files.pythonhosted.org/packages/13/ae/c3a25f1456604f088dfd800d12d2b219fb2f7d06a81672dacb9a25226b49/chrphb_friends-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "da722afe7fe878f95bc0063f2566a6da3ab5fd7ae588d63a4e1a519c1c85845b",
"md5": "5d093b8e902d4c4aca6c74bfce817940",
"sha256": "abff61e82ccd38b3af3dfaed9a709cb83533c8cc390c4b824e95a9e0016fe022"
},
"downloads": -1,
"filename": "chrphb_friends-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "5d093b8e902d4c4aca6c74bfce817940",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 9008,
"upload_time": "2025-01-19T17:11:35",
"upload_time_iso_8601": "2025-01-19T17:11:35.829375Z",
"url": "https://files.pythonhosted.org/packages/da/72/2afe7fe878f95bc0063f2566a6da3ab5fd7ae588d63a4e1a519c1c85845b/chrphb_friends-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-19 17:11:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "chrphb",
"github_project": "chrphb-friends",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "chrphb-friends"
}
JSON
