project-educate1

Console bot assistant

Prerequisites

• Python (version 3.X.X)
• Git (version 2.X.X)

Installing

1. Clone the repository:

   git clone https://github.com/KatNezabydka/educated.git

2. Install the package:

   pip install .

3. Run from console:

   educate

Additional Setup

• Ensure Python is installed on your system. If not, download and install Python from the official website.
• Set up Git on your local machine if you haven't already. Download and install Git from the official website.

Libraries Used

• Black: A Python code formatter.
• Colorama: Cross-platform colored terminal text.
• Faker: Fake data generator for Python.
• Prompt-toolkit: Interactive command line

Chat Bot

Introduction

This chatbot provides functionality to manage an address book. It offers the following commands:

• help: Calls the show_help() function, which displays usage help for the program.
• hello: Prints a greeting message.
• add-contact [name] [phone]: Adds a new contact with the specified name and phone number.
• add-address [name] [address]: Adds an address for the specified contact.
• add-email [name] [email]: Adds an email address for the specified contact.
• edit-phone [name] [new phone]: Changes the phone number for the specified contact.
• show-phone [name]: Shows the phone number for the specified contact.
• find-contact: [name] show all information about person
• show_contacts: Shows all contacts in the address book.
• add-birthday [name] [birthday]: Adds a birthday for the specified contact.
• show-birthday [name]: Shows the birthday for the specified contact.
• show-birthdays: Shows the birthday for the specified contact.
• show-next-week-birthdays: Shows birthdays happening within the next week.
• add-note [note] [tag] [content]: Adds a new note to the notebook.
• edit-note-content [note_name] [new_content]: Edits the content of the note with the specified name.
• edit-note-tag [note_name] [new_tag]: Edit the note tag.
• delete-note [note_name]: Deletes the note with the specified name.
• show-note [note_name]: Shows the note with the specified name.
• show-all-notes: Shows all notes, sorted by name.
• find-notes-by-tag [tag]: Shows notes with the specified tag.
• show-all-notes-tag: Shows all notes, sorted by tags.
• close or exit: Closes the program, saving data before exiting.

The chatbot supports color highlighting for commands and error messages for user convenience.

Authors

• KatNezabydka - Team Lead / Python developer
• eilerbit - Scrum master / Python developer
• Maria-Shymanska - Python developer
• serhiizghama - Python developer
• Ingoo1 - Python developer

License

This project is licensed under the MIT License.