Skip to content

Latest commit

 

History

History
95 lines (62 loc) · 3.09 KB

README.md

File metadata and controls

95 lines (62 loc) · 3.09 KB
Raw

Build Status Codacy Badge Maintainability Test Coverage Coverage Status

Contacts

Utterly fantastic phone book cli app. With this cli app:

  • You can save all of your contacts with ease.
  • Contacts can also be edited in case of errors.
  • Quickly update or delete outdated contacts. All these features in one cli app.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

A few requirements to install, run and test this project.

Git : Use git to git clone this project locally. git Python: This project is based on python

Installing

Type git clone https://github.com/JoshuaOndieki/contacts.git in your terminal. Virtual env: Create a virtualenv to install this project requirements. Pip install: pip install -r requirements.txt Just type python app.py and the app will launch.

Usage

The app supports four main commands. add, edit,view and delete Use the help command in case you forget how to use these commands.

App Launch

Add Example

add Some Name 25400000000

Add

Edit Example

edit 25400000000 Updated Name

Edit

View Example

view

View

Delete Example

delete 25400000000

Delete

Errors handled

Errors

Running the tests

Type nosetests tests to see the tests pass.

Built With

  • Docopt - Command line interface description language.
  • Pip - Dependency Management

Versioning

This project uses tags for release and versioning. For the versions available, see the tags on this repository.

Authors

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

  • Andela for this wonderful learning opportunity
  • Inspiration
  • David Kironde
  • Teammates, bootcampers and facilitators for their support.