bizdays documentation

bizdays provides business-day calculations around a NumPy-backed Calendar API. The top-level bizdays.Calendar accepts scalar dates, Python sequences, NumPy arrays, and pandas date-like inputs, while returning NumPy scalars or arrays for consistent vectorized behavior.

This site documents bizdays 2.0:

• build calendars directly with bizdays.Calendar

• load packaged calendars with Calendar.load(name=...)

• load custom JSON calendar files with Calendar.load(filename=...)

• work with Python, NumPy, and pandas date-like inputs using the same API

Install

pip install bizdays

bizdays 2.0 runs on Python 3.10 to 3.14. Each optional calendar provider is an extra:

pip install "bizdays[pmc]"    # pandas_market_calendars, names with the PMC/ prefix
pip install "bizdays[xcal]"   # exchange_calendars, names with the XCAL/ prefix
pip install "bizdays[work]"   # workalendar, names with the WORK/ prefix

The notebooks under docs/source/ are the canonical documentation examples and are executed during the Sphinx build.

Documentation map

• Quickstart introduces the core workflow.

• Creating and loading calendars shows packaged calendars, constructor-based calendars, and JSON calendar files.

• Calendar data lists every calendar source, its range and how the data is updated.

• pandas examples focuses on pandas inputs and NumPy-backed outputs.

• getdate documents date-expression lookups.

• API reference is the method-by-method reference.

• Migration guide is the only page that discusses older documentation patterns.

• Release notes: CHANGELOG.md.

Contents

• Quickstart
• pandas examples
• Creating and loading calendars
  • Calendars that come with the package
  • Creating a calendar from scratch with Calendar(...)
  • JSON calendar layout
  • Optional calendar provider integrations
• Calendar data
  • Ranges
  • Providers
  • Updating the data
• getdate
• Migration guide
  • Inventory
  • Install and packaging
  • Public names
  • Building and loading calendars
  • Inputs
  • Outputs and missing values
  • Vectors and calendar range
  • getdate
  • getbizdays
  • Calendar data
  • New in 2.0
  • What did not change
• API reference
  • Public API
  • Output types
  • Missing values
  • Vector arguments
  • Errors
  • Calendar discovery
  • Calendar construction
  • Calendar range
  • Loading calendars
  • Core business-day calculations
  • Date adjustment methods
  • Date expression lookup
  • Business days in a period

Indices and tables

• Index

• Module Index