Assistant Bot is a console-based application written in Python. It serves as a personal assistant for managing contacts and notes efficiently.
git clone https://github.com/snegurova/project-magicdev.git
cd project-magicdev
pip install -r requirements.txt
Install the application (see instructions below)
Run the application:
magicdev
These instructions will guide you through the process of installing the bot on your MacOs computer.
Run commands in the terminal in the project folder
python3 -m venv env
source env/bin/activate
pip install -r requirements.txt
pip install .
Run the application:
magicdev
These instructions will guide you through the process of installing the bot on your Windows computer.
Open Terminal.
Type cmd to launch the Windows Command Prompt.
Enter the following command to create a Python virtual environment: py -m venv <DIR>
Replace <DIR> with the name of the folder where you want to save the virtual environment (e.g., env, vene, myenv, etc.).
Once the virtual environment is created, activate it by entering the following command: <DIR>\Scripts\activate
Install 'pip' and 'setuptools' by running the following command:
py -m pip install pip setuptools
Install the bot by running the following command:
py -m pip install -e .
After successful installation, you can start the bot by entering the following command: magicdev
The application accepts various commands to perform different actions. Here are the available commands:
| Command | Description |
|---|---|
| hello | Say Hi to Bot and it will start work. |
| help | List of all bot commands. You`re already here. |
| add [name] [phone] | Add a new contact. |
| change [name] [old phone] [new phone] | Change contact information. |
| phone [name] | Find phone number of a contact. |
| add-email [name] [email] | Add email to a contact. |
| change-email [old email] [new email] | Change email of a contact. |
| add-birthday [name] [birthday-date] | Add birthday to a contact. |
| change-birthday [name] [new birthday] | Change birthday of a contact. |
| show-birthday [name] | Show birthday of a contact. |
| birthdays [day] | Show birthdays within a range of days. |
| add-address [name] [address] | Add address to a contact. Address argument should not contain spaces. |
| change-address [name] [new address] | Change address of a contact. |
| search [keyword] | Give back list of contacts by keyword (phone, name etc) with partial coincidence. |
| all | Show all contacts. |
| delete [name] | Delete a contacts. |
| add-note [title] | Create a note. |
| change-note [title] | Change a note description. |
| find-note [title] | Find a note by title. |
| search-note [keyword] | Give back list of notes by keyword (tag or title) with partial coincidence. |
| delete-note [title] | Delete a note. |
| all-notes | Show all Notes. |
| add-tag [note-title] | Add a tag to a note. |
| remove-tag [note-title] | Remove tag from note. |
| close/exit | Close the program with saving data. |
This project is licensed under the MIT License - see the LICENSE file for details.