Skip to main content

Track number of remaining vacation days.

Project description

Vacation Tracker

A command-line tool to track and manage vacation periods with support for holidays and date ranges. This tool helps you manage your vacation days, taking into account:

  • Vacation day entitlements per month
  • Public holidays based on country/region
  • Weekend exclusions
  • Year transitions and expiration dates
  • Detailed summaries and reporting

Installation

Install using pip:

pip install vacation-tracker

Configuration

First, create a new tracking configuration:

vacation-tracker new --days 2.5 --first-year 2023 --first-month 1

This creates a vacation-periods.toml file with your vacation tracking settings. The configuration includes:

  • Days earned per month
  • Tracking period (start/end dates)
  • Country/region for holiday calculations
  • List of vacation periods

Example configuration:

days-per-month = 2.5
first-year = [2023, 1]  # Start tracking from January 2023
last-year = [2024, 12]  # Track until December 2024
country = ["DE", "BY"]  # Germany, Bavaria region
categories = ["public", "catholic"]  # Holiday categories to consider

Usage

Adding Vacation Periods

Add single day vacations:

vacation-tracker add "Doctor Appointment" --first 2023-05-15 

Add multi-day periods:

vacation-tracker add "Summer Holiday" --first 2023-08-01 --last 2023-08-15

Viewing Vacation Summary

Basic summary:

vacation-tracker show

This displays a table with:

  • Yearly entitlements
  • Utilized days
  • Remaining days
  • Expired allocations

Detailed view with individual periods:

vacation-tracker show --detailed

Example output:

 Year  Months  Entitlement  Real Util  Adj Util  Remaining
 2023  12      30           25         25        5 (expired)
 ├─ 01.08-15.08 (11): Summer Holiday
 └─ 15.05 (1): Doctor Appointment
 2024  12      30           0          0         30

Features

  • Automatically handles:
    • Weekend exclusions
    • Public holidays based on country/region
    • Vacation day expiration
    • Year transitions
    • Period overlaps prevention
    • Cross-year vacation splits
  • Configurable holiday categories
  • Support for partial day accumulation (e.g., 2.5 days/month)
  • Detailed vacation period tracking and reporting

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

vacation_tracker-0.1.1.tar.gz (11.8 kB view details)

Uploaded Source

Built Distribution

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

vacation_tracker-0.1.1-py3-none-any.whl (7.6 kB view details)

Uploaded Python 3

File details

Details for the file vacation_tracker-0.1.1.tar.gz.

File metadata

  • Download URL: vacation_tracker-0.1.1.tar.gz
  • Upload date:
  • Size: 11.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for vacation_tracker-0.1.1.tar.gz
Algorithm Hash digest
SHA256 25044c95a624aec92e9e99499e0c07df87d47952d0f53ab5bc74b3bfe6984373
MD5 a8a16a0f5ce31253958311db4f9146ea
BLAKE2b-256 bbf6a0b2508a87eed803db3a90d12694095d1b7c61a5263e1d12a701fb7a7d3c

See more details on using hashes here.

File details

Details for the file vacation_tracker-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for vacation_tracker-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 acaf53a370fdd130aadad2d64c026e0f4f52ac491c68a83e78a59a85b4ad2961
MD5 8463db3cf35ad4191224c4f1ee9686d8
BLAKE2b-256 d694ee99a1ab4a88902153dbea0d0a2ced0cc1584e19629156f9119705890a10

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