Skip to main content

Simple CLI assistant with contacts and notes management features.

Project description

📒 Contacts and Notes Manager

A simple CLI application for managing your personal contacts and notes. Designed to keep your address book and daily thoughts organized and accessible.


📌 Menu

Features

👥 Contact Management

  • Add contacts
  • Store, edit, delete phone numbers per contact
  • Store, edit, delete contact's email
  • Store, edit, delete contact's birthday
  • Store, edit, delete contact's address
  • Track upcoming birthdays in defined days
  • Search contacts by name (partial or full match) and phone

📝 Notes Management

  • Add, edit, and delete notes
  • Tag notes with keywords
  • Search notes by title (partial or full match)

💾 Persistance Feature

  • Store contacts and notes into files on your disk.

Installation

Suggestion: You can create a virtual environment to use the package encapsulated from the system-wide Python on your OS:

python -m venv .venv
  1. Run command to install package:
pip install project-rV5P74d8

ENV variables

If variables are not set, files will be create by default in current branch with default name.

  • ADDRESS_BOOK_FILE_NAME: custom path to address book file.
  • NOTE_BOOK_FILE_NAME: custom path to note book file.
  1. Run application:
cli-assistant

Alternatively, you can run assistant with your file path using next command example:

ADDRESS_BOOK_FILE_NAME=<address_book_file_path> NOTE_BOOK_FILE_NAME=<note_book_file_path> cli-assistant

Command Reference

Command Name Description
help Show list of available commands
show_all Show all contacts info (name, phones, email, address, birthday) from the contact book.
create_contact Create a contact with name and phones (optional, separated by comma) from the contact book.
find_contact Find a contact from the contact book by full or partial name.
find_contact_by_phone Find a contact from the contact book by phone.
edit_name Edit a contact name.
delete_contact Delete a contact from the contact book.
show_phones Show all contact's phones.
add_phone Add phones, separated by comma, to contact.
edit_phone Edit contact's phone.
delete_phone Delete contact's phone.
birthdays Show upcoming contact birthdays within the specified number of days from today.
show_birthday Show all contacts' birthdays, matched by name partially or full.
add_birthday Add contact's birthday.
add_email Add contact's email.
edit_email Edit contact's email.
delete_email Delete contact's email.
add_address Add contact's address.
edit_address Edit contact's address.
delete_address Delete contact's address.
show_notes Show all notes.
search_note_by_tag Search notes by tags.
add_note Add note with title and description.
find_note Find notes by title, matching partially or fully.
update_note Update note by title, matching partially or fully.
delete_note Delete note by title, matching partially or fully.
add_tags_to_note Add tags by note title, matching partially or fully.
update_tags_from_note Update tags by note title, matching partially or fully.
exit / close Close the app.

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

project_rv5p74d8-1.0.7.tar.gz (15.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

project_rv5p74d8-1.0.7-py3-none-any.whl (22.2 kB view details)

Uploaded Python 3

File details

Details for the file project_rv5p74d8-1.0.7.tar.gz.

File metadata

  • Download URL: project_rv5p74d8-1.0.7.tar.gz
  • Upload date:
  • Size: 15.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.6

File hashes

Hashes for project_rv5p74d8-1.0.7.tar.gz
Algorithm Hash digest
SHA256 438c4a5eb5bf01bd10d7d42e8e4b3e4e9e672e70f73e96c42c87580f94c7bf28
MD5 f79a5f2f8538dab894e7900b907db2f7
BLAKE2b-256 7d5aa26cf7a405a36207fe6273010f8449c15e798fbd242ad522f7f8882531d3

See more details on using hashes here.

File details

Details for the file project_rv5p74d8-1.0.7-py3-none-any.whl.

File metadata

File hashes

Hashes for project_rv5p74d8-1.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 3dadb346fde04534a9a6a3d74a69dcf3bee8237054c7533073e61c46d859b429
MD5 06eb79780b177d829812838ca1e9c9f2
BLAKE2b-256 93d7fe564f418b77aeab882a46dfdb5254e31a080380a9389122e837be6b3ed5

See more details on using hashes here.

Supported by

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