https://github.com/mmolenda/missalemeum
1962 Roman Catholic Missal for the Traditional Latin Mass
https://github.com/mmolenda/missalemeum
Last synced: 10 days ago
JSON representation
1962 Roman Catholic Missal for the Traditional Latin Mass
- Host: GitHub
- URL: https://github.com/mmolenda/missalemeum
- Owner: mmolenda
- License: mit
- Created: 2015-02-11T20:48:59.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-10-25T12:39:53.000Z (7 months ago)
- Last Synced: 2024-11-03T03:12:02.826Z (6 months ago)
- Language: Python
- Homepage: https://www.missalemeum.com
- Size: 20.3 MB
- Stars: 69
- Watchers: 13
- Forks: 18
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-catholic - Missale Meum - Misal católico romano de 1962 para la misa tradicional en latín (Aplicaciones-web)
- awesome-church-calendar - mmolenda/Missal1962
README
# Missale Meum
1962 Roman Catholic Missal for the Traditional Latin Mass.
The application consists of Python/Flask API, serving calendar and propers for a given day, and Nextjs/React frontend consuming
and presenting the data. The application utilizes data files from
[Divinum Officium](https://github.com/DivinumOfficium/divinum-officium), which is linked through a
[git submodule](./backend/resources).
## Features
* Calculates the 1962 calendar for given liturgical year
* Shows Proprium Missae (variable parts of the Mass) for a given date
* Provides Ordo Missae (fixed parts of the Mass)
* Exposes calendar in iCal format
* Shows everything in a slick, responsive UI
At the moment the application supports English and Polish vernacular languages. As the data for many other languages
is available in Divinum Officium, it is relatively easy to support them. Volunteers are welcome to contribute (see below).
## Running the application
### Prerequisites
* Python >=3.6
* node
### Installation
Clone the repository using `--recursive` switch to also fetch [divinum-officium](https://github.com/DivinumOfficium/divinum-officium)
as a submodule - it's used to display propers.
Create a virtualenv and install dependencies `pip install -r backend/requirements.txt`.
### Configuration
By default the application is using `lru_cache` to cache responses from `missalemeum.controller` functions (which are
used by `missalemeum.api` to fetch the data).
To disable caching one need to set environment variable `MISSAL_NO_CACHE` to `True`
Backend API URL needs to be provided in `API_URL` env variable.
Application build version is provided in `NEXT_PUBLIC_BUILD_VERSION` env variable.
### Run the python development API
```bash
$ export PYTHONPATH=$PYTHONPATH:backend
$ python backend/api/app.py
```
and navigate to http://0.0.0.0:8000/en/api/v5/version.
### Run the nextjs development UI
Provide local dev API URL in variable `API_URL`:
```bash
export API_URL=http://localhost:8000
```
Navigate to `./frontend`
```
npm ci
npm run dev
```
and navigate to http://0.0.0.0:3000.
## API specficiation
See [openapi.yaml](openapi.yaml) or [auto-generated swagger API documentation](https://editor.swagger.io/?url=https://raw.githubusercontent.com/mmolenda/missalemeum/master/openapi.yaml) based on the latter.
## Docker
Docker compose setup for this project runs three containers - backend, frontend and caddy server as a reverse proxy.
```bash
$ docker compose up --build
```
and navigate to http://0.0.0.0:8000/.
## Command line (CLI)
Calculate the calendar
```bash
# current year
$ python missalemeum/cli.py calendar
# selected year
$ python missalemeum/cli.py calendar 2020
```
Show Proprium Missae for given date
```bash
$ python missalemeum/cli.py date 2018-05-03
```
Show Proprium Missae for given observance
*Observance ID can be obtained from calendar's output*
```bash
# Second Sunday of Advent
$ python missalemeum/cli.py proper tempora:Adv2-0:1:v
# The Seven Dolors of the Blessed Virgin Mary
$ python missalemeum/cli.py proper sancti:09-15:2:w
```
## Localization
### Backend
1. Copy folder `missalemeum/constants/en` into `missalemeum/constants/` and translate the files
2. Add mapping between your language ISO-639-1 code and [Divinum Officium language folder](https://github.com/DivinumOfficium/divinum-officium/tree/master/web/www/missa) in `LANGUAGES` in `missalemeum/constants/common.py`
3. Generate Babel language files:
- Create .po file: `cd missalemeum/missalemeum && pybabel init -i messages.pot -d translations -l `
- Provide translations in file generated in `missalemeum/translations//LC_MESSAGES/messages.po`
- Compile babel files: `pybabel compile -d translations`
4. Copy folder `missalemeum/templates/en` into `missalemeum/templates/` and translate the files
5. Add source files for non-regular propers, like Ash Wednesday or Maundy Thursday in `resources/divinum-officium-custom/web/www/missa/`
6. Add tests in [test_propers.py](tests/test_propers.py)
### Frontend
1. Add your language to `supportedLanguages` array in [App.js](frontend/src/App.js)
2. Provide translation of fronted elements in [intl.js](frontend/src/intl.js)
### Verification
Run the application and verify everything is being displayed properly. Check at least one full year from now. Most likely you'll encounter
some issues with Divinum Officium source files. In such case correct them in Divinum Officium project and update the submodule.
## Dev info
`kalendar.factory.MissalFactory#create` instantiates and builds `kalendar.models.Calendar` object.
`kalendar.models.Calendar` internally keeps the data in an ordered dict where a key is a `datetime.date` object, and the
value is an instance of `kalendar.models.Day` class.
Each `kalendar.models.Day` contains three list properties, `tempora`, `celebration` and `commemoration`, each one
containing `kalendar.models.Observance` objects, representing given observance. `tempora` refers to the liturgical
time, such as "The first Friday after Pentecost", `celebration` holds `kalendar.models.Observance`s that are actually
celebrated in given day, such as "Assumption of Mary". `commemoration` contains objects representing observances
that should be commemorated with the main celebration.
Each `kalendar.models.Day` has method `get_proper`, which calculates the actual readings in vernacular and Latin for given
calendar day.
Each `kalendar.models.Observance` has method `get_proper`, which returns the readings for the given observance (regardless
of its place in the calendar).
## Tests
Add `backend` directory to the `PYTHONPATH` environment variable and use `pytest`.
Or in the root directory set an alias for `pytest`: `alias pytest="PYTHONPATH=$(pwd)/backend:$(pwd)/tests pytest"`