catholic-mass-readings¶

Welcome to the catholic-mass-readings documentation! Here you will find links to the core modules and examples of how to use each.

A Python package that enables converting a US Zip Code into a timezone.

Provides an API for scraping the web page from Daily Readings website of United States Conference of Catholic Bishops.

Modules¶

If there is functionality that is missing or an error in the docs, please open a new issue here.

Install¶

To install catholic-mass-readings from PyPI, use the following command:

$ pip install catholic-mass-readings

You can also clone the repo and run the following command in the project root to install the source code as editable:

$ pip install -e .

Indices and tables¶

Examples¶

The following example queries for the mass on a particular date:

The following example queries for a range of Sunday masses:

To query for a range of masses (step how you want to):

To query for the available mass types for a particular date:

# To get a mass for a particular date:
python -m catholic_mass_readings get-mass --date 2024-12-25 --type vigil

# To query for a range of Sunday masses:
python -m catholic_mass_readings get-sunday-mass-range --start 2024-12-25 --end 2025-01-01

# To query for a range of masses (step how you want to):
python -m catholic_mass_readings get-mass-range --start 2024-12-25 --end 2025-01-01 --step 7

# To query for a list of mass types on a particular date:
python -m catholic_mass_readings get-mass-types --date 2025-12-25

# or saving to a file...

# To get a mass for a particular date:
python -m catholic_mass_readings get-mass --date 2024-12-25 --type vigil --save mass.json

# To query for a range of Sunday masses:
python -m catholic_mass_readings get-sunday-mass-range --start 2024-12-25 --end 2025-01-01 --save mass.json

# To query for a range of masses (step how you want to):
python -m catholic_mass_readings get-mass-range --start 2024-12-25 --end 2025-01-01 --step 7 --save mass.json