event-scheduler

Developed by Stefan Kairinos

This repo is my solution to the task described in task_description.pdf.

Note: This was developed using VSCode. Some ease-of-use settings are pre-configured in the .vscode directory.

How to setup

1. Create a virtual environment (venv) in the root directory;
2. Activate your venv;
3. Upgrade to the latest version of pip;
4. Pip install the requirements.txt;
5. (optional) Pip install the requirements.local.txt for linting and formatting support.

How to run

1. Run command (make sure your venv is activated!): python main.py --input-events;
2. Enter event in the format specified in the task description. Repeat until satisfied.
3. Enter blank line to stop event collection.

Sample run (on 2022/11/12 02:00):

Enter blank line to stop event collection.
New Event: 2022/11/14 15:00 -> 2022/11/14 16:00 - Meet Jamie for coffee
Scheduled Event: 2022/11/14 15:00 -> 2022/11/14 16:00 - Meet Jamie for coffee
New Event: 2022/08/23 16:15 -> 2022/08/23 17:00 - Guitar lessons
root: 2 validation errors for Event
start
  InThePastError: Date and times cannot be in the past (type=value_error.inthepast)
end
  InThePastError: Date and times cannot be in the past (type=value_error.inthepast)
Rescheduled Event: 2022/11/14 09:00 -> 2022/11/14 09:45 - Guitar lessons
New Event: 2022/11/14 09:30 -> 2022/11/14 10:00 - Dance party
Rescheduled Event: 2022/11/14 09:45 -> 2022/11/14 10:15 - Dance party
New Event:

2022-11-14
        2022/11/14 09:00 -> 2022/11/14 09:45 - Guitar lessons
        2022/11/14 09:45 -> 2022/11/14 10:15 - Dance party
        2022/11/14 15:00 -> 2022/11/14 16:00 - Meet Jamie for coffee

Things to Note

• If error(s) occurs, a human readable description will be printed.

root: 2 validation errors for Event
start
  InThePastError: Date and times cannot be in the past (type=value_error.inthepast)
end
  InThePastError: Date and times cannot be in the past (type=value_error.inthepast)

• An event's scheduled start and end time are printed after each entry.

Scheduled Event: 2022/11/14 15:00 -> 2022/11/14 16:00 - Meet Jamie for coffee

• If an event is rescheduled, it will be stated.

Rescheduled Event: 2022/11/14 09:45 -> 2022/11/14 10:15 - Dance party

• The complete schedule will be printed once all events are collected.

2022-11-14
        2022/11/14 09:00 -> 2022/11/14 09:45 - Guitar lessons
        2022/11/14 09:45 -> 2022/11/14 10:15 - Dance party
        2022/11/14 15:00 -> 2022/11/14 16:00 - Meet Jamie for coffee

• You cannot schedule events in the past.

New Event: 2022/08/23 16:15 -> 2022/08/23 17:00 - Guitar lessons
...
Rescheduled Event: 2022/11/14 09:00 -> 2022/11/14 09:45 - Guitar lessons

Unit Tests

To run unit tests simply run: python -m unittest. Alternatively, use VSCode's (or IDE of choice) built in test runner.

This solution has high test coverage so it's recommended to review the UTs to better understand how this solution is intended to work.