Metadata-Version: 2.1
Name: adbookfromkevin
Version: 0.0.1
Summary: A small example address book package
Home-page: https://github.com/Julian-Spring-2022/stack-machine-kevingzr-gsb
Author: Zhirong (Kevin) Guo
Author-email: zguo22@gsb.columbia.edu
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/Julian-Spring-2022/stack-machine-kevingzr-gsb
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE.txt

# Address Book Program (Final Project)


# Overview

Inspired by the contacts feature on IOS, I created a comprehensive address book program that could be edited and exported as .csv format

pypi Link to Author: https://pypi.org/user/kevingzr

github link to Author: https://github.com/kevingzr-gsb

## Sections
- [Installation](#installation)
- [Interface](#interface)

---
## Installation
This program is built under python 3.9 environment.

There is only one dependency for running the program, which is pandas

Please follow the following command in your computer:

> pip install pandas
>
> pip install adbookfromkevin 

pypi Link to Author: https://pypi.org/user/kevingzr/

github link to Author: 

If you want to run the tests, you need to install these packages:

> pip install pytest
>
> pip install sys

Please remember to import these packages and make sure they are up to date.

Finally, please follow this step in your code:

> from adbookfromkevin import adbookfromkevin as AB

---
## Interface

There are a lot of functions in this program, but the user only need to invoke one function:

> AB.Address_Book()

After running this command, the user will be presented with the following:

> ------------Please Choose Options Below-------------------
>
> 1: Add Contact
>
> 2: Display All Contacts
>
> 3: Display Favorites
>
> 4: Filter Contact by Location and Email
> 
> 5: Find Contact by Name
> 
> 6: Edit Contact Information
>
> 7: Delete Contact
> 
> 8: Add to Favorites
> 
> 9: Export Address Book as CSV File
> 
> 0: Terminate Program

User will need to select these options manually by enter the number accordingly:

> Select option: 

It should be sufficiently straightforward! Please follow the prompts after selecting your option:)










