birthdays-cli 0.1.0

A command-line utility for displaying and managing birthdays from JSON- or vCard-based contacts.

birthdays

birthdays is a robust Python command-line tool designed to conveniently manage, track, and celebrate your contacts' birthdays.

Features

• Customizable Sorting: List birthdays exactly how you want to see them (by upcoming, recent, age, name, or date)
• CRUD Operations: Easily add, edit, and delete entries. The deletion and edit commands feature a convenient fuzzy search so you don't have to type out exact names
• Smart Imports: Import contacts directly from .vcf vCard files or JSON databases
• Interactive Merging: During imports, the CLI intelligently detects duplicates or data collisions and prompts you to safely merge them
• Leapling Support: Configure how leap year birthdays (February 29th) are handled in non-leap years, choosing to celebrate either the day before or the day after
• Festive UI: Every date is assigned a unique, deterministic emoji to keep the terminal vibe bright and colorful

Requirements

• Python 3.11+

Installation

Install the package from PyPI using your favorite package management tool such as pip, pipx, or uv:

pip install birthdays-cli

Or install the latest version from source:

git clone https://github.com/l1asis/birthdays.git
cd birthdays
pip install .

Usage

birthdays uses simple subcommands to organize different operations. You can append --help to any command to see its available arguments.

Listing Birthdays

[!NOTE] By default, this sorts by upcoming birthdays in descending order so the most immediate celebrations are right at your cursor.

birthdays list

Options:

• --sort: Choose from name, date, upcoming, recent, or age.
• --order: Choose asc or desc.
• -f, --file: Temporarily read and display birthdays directly from a .vcf or .json file without modifying your local database.

Adding an Entry

[!NOTE] The date can be formatted as YYYY-MM-DD, or simply MM-DD if the year is unknown.

birthdays add "John Doe" 1990-05-14 --note "Loves chocolate cake"

Editing an Entry

[!NOTE] You can use either the name or UUID. You only need to pass the flags for the specific data you want to change.

birthdays edit "John Doe" --date 1991-05-14

Deleting an Entry

[!TIP] The CLI uses fuzzy matching, so typing a partial name usually works! Append -y to skip the confirmation prompt.

birthdays delete "John Doe"

Importing Contacts

[!TIP] The interactive prompt will guide you through any data collisions. Append -y to automatically skip these prompts and blindly merge safe entries.

birthdays import ./contacts.vcf

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feat/amazing-feature)
3. Commit your Changes (git commit -m 'feat: ✨ add some amazing-feature')
4. Push to the Branch (git push origin feat/amazing-feature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.