shelbyvjacobs / python-cli-app

Contact Book

Description

This is a Python contact book application in your command line.

Example

Technologies Used

• Python
• PostgreSQL
• Peewee

Goals

• Users should be able to create new contacts.
• Users should be able to see a list of contacts in their contact book.
• Users should be able to find a contact by the contact's first name.

Future goals:

• Build a user interface with tkinter, pygame, or PySimpleGUI.
• Include ability for users to update and delete contacts.

Getting Started

1. Clone this repository

git clone https://github.com/shelbyvjacobs/python-cli-app.git

2. Change into the python-cli-app directory.
3. Install required dependencies found in the Pipfile by running pipenv install.
4. In your terminal, start PostgreSQL by running psql.
5. Create a database named "contacts".
6. Run python main.py in the root of the python-cli-app in your terminal.
7. Follow to prompts in the application!

Contribution Guidelines

If you would like to contribute code, identify bugs, or propose improvements, please fork this repository and submit a pull request with your suggestions. Below are some helpful links to help you get started:

1. Project's main repository
2. Project's issue tracker