Skip to main content

Contacts Assistant is a bot designed to help you manage your address book efficiently. Below is a list of available commands, their functions, and required arguments. Additionally, you can add your notes to our notebook.

Project description

Contacts Assistant

Contacts Assistant is a bot designed to help you manage your address book efficiently. Below is a list of available commands, their functions, and required arguments. Additionally you can add your notes to our notebook

Initialization

locally

  1. Initialize virtual environment
    • .venv\Scripts\activate.bat - Windows у командному рядку (CMD)
    • .venv\Scripts\Activate.ps1 - Windows у PowerShell
    • source .venv/bin/activate - macOS та Linux
  2. pip install -r requirements.txt
  3. python src\main.py
  4. use one of commands presented below (bot will suggest you commands and named arguments that you need)

installed package

  1. Initialize virtual environment
    • .venv\Scripts\activate.bat - Windows у командному рядку (CMD)
    • .venv\Scripts\Activate.ps1 - Windows у PowerShell
    • source .venv/bin/activate - macOS та Linux
  2. pip install contacts-assistant
  3. contacts-assistant

List of Commands

Contacts Book

  • "hello":

    • Greeting
    • Arguments: None
  • "close" | "exit":

    • Save the current state and stop the bot assistant
    • Arguments: None
  • "add_contact":

    • Add a contact to the address book or update an existing contact
    • Arguments: name, phone, email, birthday
  • "update_phone":

    • Change the phone number of an existing contact
    • Arguments: name, oldphone, newphone
  • "delete_contact":

    • Delete contact by name
    • Arguments: name
  • "set_birthday":

    • Add a birthday to a contact
    • Arguments: name, date %d.%m.%Y
  • "show_birthday":

    • Show the birthday of a contact
    • Arguments: name
  • "find_contact_by_name":

    • Find contact by name
    • Arguments: name
  • "find_contact_by_phone":

    • Find contact by phone
    • Arguments: phone
  • "find_contact_by_email":

    • Find contact by email
    • Arguments: email
  • "show_all_contacts":

    • Returns a string representation of the address book
    • Arguments: None
  • "upcoming_birthdays":

    • Returns a list of upcoming birthdays within the specified number of days
    • Arguments: days
  • "update_email":

    • Update contact email
    • Arguments: name, email
  • "add_address":

    • Add or update the address of a contact
    • Arguments: name, addresstype, street, city, postalcode, country
  • "remove_address":

    • Remove the address of a contact
    • Arguments: name, addresstype

NoteBook

  • "add_note":

    • Add a new note
    • Arguments: None
  • "find_note":

    • Find a note by title
    • Arguments: title
  • "delete_note":

    • Delete a note by title
    • Arguments: title
  • "delete_all_notes":

    • Delete all notes
    • Arguments: None
  • "update_note":

    • Update a note by title
    • Arguments: title
  • "search_notes":

    • Search for notes containing the query in their title or content
    • Arguments: query
  • "filter_notes_by_tag":

    • Filter notes by tag
    • Arguments: tag
  • "notes_due_in_days":

    • Show notes that are due within the next specified number of days
    • Arguments: days
  • "show_all_notes":

    • Show all notes
    • Arguments: None

These commands help you manage and retrieve contact information and notes efficiently. Use them to keep your contacts book organized and up-to-date.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

contacts_assistant-0.0.10.tar.gz (18.9 kB view details)

Uploaded Source

Built Distribution

contacts_assistant-0.0.10-py3-none-any.whl (23.7 kB view details)

Uploaded Python 3

File details

Details for the file contacts_assistant-0.0.10.tar.gz.

File metadata

  • Download URL: contacts_assistant-0.0.10.tar.gz
  • Upload date:
  • Size: 18.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.3

File hashes

Hashes for contacts_assistant-0.0.10.tar.gz
Algorithm Hash digest
SHA256 c084660013899574c7d18ab34db57eaed16810880c19eb528e5f77c81180563c
MD5 824b6a03b72dc9e5177c1d6568bb4719
BLAKE2b-256 1f1e0dce2dfab7dac021607c76d5b903a6d106e5e9b9b484be9da0f26be30e57

See more details on using hashes here.

File details

Details for the file contacts_assistant-0.0.10-py3-none-any.whl.

File metadata

File hashes

Hashes for contacts_assistant-0.0.10-py3-none-any.whl
Algorithm Hash digest
SHA256 5aa25514ec13646509a6a28226f35650b3349d37c5d0d04fe25a8565b477741d
MD5 0a799376c15a9123c9ac7288a81efa3f
BLAKE2b-256 8259c9137a737b7affe898b3dbce06bbfb3ee632a7420360655c1c61065daac4

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page