studybuffalo/rdrhc_calendar

Generates an iCal file from a Microsoft Excel schedule

RDRHC Calendar Generator

A specialized program to create an iCal file from a Microsoft Excel schedule.

Initial Setup (Development)

1. Install the virtual environment

pipenv install --dev

2. Create the required config file - you may copy the example config located at /config/.rdrhc_calendar.cfg.
3. Update the config file to specify all the required details (as outlined in the example config file.

Running Program

pipenv run python run.py path_to_config_file

Testing

Unit tests for this application can be run via the standard pytest commands:

# Standard testing
pipenv run pytest

# Tests with coverage reporting
pipenv run pytest --cov=modules --cov-report=xml

All reports can be placed in the reports folder, whose contents are excluded from source control.

Linting

Linting for this application can be run with the following commands:

# Linting via Pylint (Excluding Tests)
$ pipenv run pylint run.py modules/

# Linting via Pylint (Tests Only)
$ pipenv run pylint tests/ --min-similarity-lines=20

# Linting via Pycodestyle
$ pipenv run pycodestyle run.py modules/ tests/

rdrhc_calendar's Issues

Merge calendar events with identical timing

Currently if a user has two shifts with the same times they display as two events. Look to see how these could be merged into a single calendar event.

openpyxl version > 2.5.5 causes errors

Known issue with this version and the formatting of the Excel files used in this program. Upgrade package when 2.6.0 version released.

Review handling of X shifts

X shifts right now are not included in the "group by date" of the new schedule. Need to review why that is and make sure it is not causing any issues.

Determine way to track notification of Null shifts

Null shifts (ones on the schedule, but are not actually associated with schedule times) are removed during the schedule extraction and formatting. Because of this, they are not uploaded to the database and there is no way to determine if a null shift has been detected before and user notified. Also may want to always notify them of null shifts given the risk of missing a shift. Could also make it a user option.

Add documentation on how to list multiple sheets

Need to include documentation on how multiple worksheets are handled (| with no spaces).