Welcome to the CLI Contact and Note Manager! This project is a command-line application designed to manage contacts and notes efficiently. Developed as part of our Master's in Computer Science program, this project aims to provide a user-friendly interface for handling various contact details and notes through simple CLI commands.
- Contact Management: Add, update, delete, and search contacts with details such as phone numbers, emails, addresses, and birthdays.
- Note Management: Create, edit, delete, and search notes with tags.
- Birthday Reminders: View upcoming birthdays within a specified number of days.
- User-Friendly Commands: Intuitive commands to perform various operations quickly and efficiently.
To get started with the CLI Contact and Note Manager, follow these steps:
Clone the repository and navigate to the project directory:
git clone https://github.com/ilyafefelov/contacts-bot
cd contacts-bot
- Install the Required Dependencies The dependencies are listed in the requirements.txt file. You can install them using pip:
pip install -r requirements.txt
- Run the Project You can run the project using the python -m command with the module path to run the main script:
python -m src.main
- Install the Project in Edit Mode This allows you to make changes to the project and see them reflected without having to reinstall the project. You can do this with the following command:
pip install -e .
- Run the Project in Edit Mode After installing the project in edit mode, you can run the project using the following command:
contact_bot
git clone https://github.com/ilyafefelov/contacts-bot
pip install contacts-bot
cls
contact_bot
Below is a detailed list of available commands and their usage:
Contact Commands
add [name] [phone] [email] [birthday]
Add a new contact with the specified name and other details.
change-phone --[name] --[old phone] --[new phone]
Change the phone number for the specified contact.
phone --[name]
Show phone numbers for the specified contact.
all
Show all contacts in the address book.
add-birthday --[name] --[birthday]
Add a birthday for the specified contact.
change-birthday --[name] --[birthday]
Change birthday for the specified contact.
show-birthday --[name]
Show the birthday for the specified contact.
birthdays [days]
Show contacts with birthdays in the next specified number of days.
search [name]
Find a contact by name.
delete --[name]
Delete a contact by name.
add-email --[name] --[email]
Add an email for the specified contact.
show-email --[name]
Show the email for the specified contact.
change-email --[name] --[new email]
Change the email for the specified contact.
delete-email --[name]
Delete the email for the specified contact.
add-address --[name] --[address]
Add the address for the specified contact.
show-address --[name]
Show the address for the specified contact.
change-address --[name] --[new address]
Change the address for the specified contact.
delete-address --[name]
Delete the address for the specified contact.
add-note --title [title] --text [text]
Add a new note with the specified title and text.
get-note [ID]
Get a note by its ID.
edit-note --id [ID] --title [title] --text [text]
Edit a note by its ID.
delete-note [ID]
Delete a note by its ID.
add-note-tag --id [ID] --tag [tag]
Add a tag to a note by its ID.
delete-note-tag --id [ID] --tag [tag]
Delete a tag from a note by its ID.
search-notes [text]
Find notes by text.
list-notes
List all notes.
hello
Get a greeting from the bot.
help
Display help information for all commands.
close
exit
Close the program.
This project is licensed under the MIT License. See the LICENSE file for more details.
We hope you find the CLI Contact and Note Manager useful and easy to use. Your feedback is highly appreciated!
Happy managing!
The Project Team 4