README.md

crewcal

Convert an airline crew schedule pdf into iCalendar format using a Large Language Model.
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About the Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. Contact

(back to top)

About the Project

Convert an airline crew schedule pdf into iCalendar format using a Large Language Model. OpenAI's gpt-4o-mini is used to extract the schedule information. iCalender files are recognized by most calendar systems (iOS, Android, Google, ++) and will create the flights on your phone/device calendar.

The PDF schedule does not need to follow a very prescribed structured format.

Development performed mostly using AIMS eCrew pdf schedules. It may work on other systems' schedules. Feel free to suggest other systems.

(back to top)

Getting Started

Prerequisites

Obtain an OpenAI API key.

Make this available as an environment variable:

export OPENAI_API_KEY=YOUR_KEY

Alternatively specify the API key in a .env file.

(back to top)

Installation

Strongly consider using pipx or a virtual environment depending on your needs.

pip install crewcal

(back to top)

Usage

CLI

To create the calendar file (schedule.ics) from a pdf schedule file (schedule.pdf):

crewcal extract schedule.pdf schedule.ics

crewcal --help shows a brief manual page.

Python Package

The following sript extracts the schedule from schedule.pdf and stores the icalendar file in schedule.ics file.

from crewcal.llm_extract import OpenAISchedule

sched = OpenAISchedule(schedule_path='schedule.pdf', to_icalendar_file='schedule.ics')

The resulting .ics file can be read by most calendar software.

(back to top)

Roadmap

• Add support for schedules from systems in addition to AIMS. I would be happy to look at suggestions, especially if you can provide sample schedules. Create a new issue to initiate a new request.

(back to top)

Contributing

Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also open a feature request or bug report. Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

Project Link: crewcal

(back to top)