Skip to content

Latest commit

 

History

8 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ScheduleFly Unofficial API

A Python library for scraping and querying ScheduleFly, an employee scheduling platform used by restaurants.

Features

  • Login & Authentication - Authenticate with ScheduleFly to obtain a session token
  • Crib Sheet Parser - Parse daily/weekly employee schedules (role, name, in/out times, details)
  • Multi-location Support - Query schedules across multiple restaurant locations under one account
  • Google Calendar Integration - Sync schedule shifts to Google Calendar (optional)

Installation

pip install requests beautifulsoup4 xmltodict numpy

Usage

from main import ScheduleFly

# Create instance (no real credentials needed for examples)
sched = ScheduleFly("your_username", "your_password")

# Get today's crib sheet (day/evening shifts)
crib = sched.crib()
print(crib)

# Get full schedule across all locations
full = sched.get_full_sched()
print(full)

# Get weekly schedule
weekly = sched.get_global_schedule()
print(weekly)

Google Calendar Sync

To enable automatic schedule syncing to Google Calendar:

  1. Create a Google Cloud Project and enable the Calendar API
  2. Download OAuth2 credentials (client ID + client secret)
  3. Place them in a credentials.json file in the project root (see credentials.json.example)
  4. The library will handle OAuth2 flow automatically
from main import ScheduleFly

sched = ScheduleFly("username", "password")
# Schedule automatically syncs to Google Calendar on init

TODO

  • Update auth to work with new ScheduleFly authentication system
  • Implement token persistence/storage
  • Add shift-off and shift-pickup functions
  • Clean up and optimize codebase
  • Add proper error handling and rate limiting
  • Add documentation with type hints

Notes

  • ScheduleFly's API is unofficial and may break without notice
  • The scraping approach targets m.schedulefly.com (mobile web interface)
  • This was originally written for restaurant management at multiple locations in Greenville, SC

License

This software is provided "as is" without warranty of any kind. Use at your own risk. ScheduleFly is a trademark of its respective owners. This project is not affiliated with or endorsed by ScheduleFly.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages