Giter VIP home page Giter VIP logo

aircal's Introduction

Aircal

This library helps visualizing Airflow's DAG run schedule. It does that by exporting future DAG runs as events to Google Calendar.

Having DAG run as events in the calendar might help you:

  • visualize the utilization of your airflow workers to better spread your jobs
  • determine when a certain DAG should be finished to monitor the service.

DAG run visualization

The library will also observe the changes to your DAGs and synchronize it with the calendar:

  • add runs for the freshly added DAGs
  • change start and/or end time when an existing DAG changes the schedule (or the execution time changes significantly)
  • delete run events when a DAG is removed (or paused)

Tip: run the sync script regularly, perhaps, with you know, Airflow :)

The library only support DAG schedules that use the standard cron syntax. The rest will be ignored (with a warning).

Warning: This is an beta stage software. Expect occassional bugs and rough edges (PR welcome).

Installation & setup

pip install aircal

Alternatively you can clone the repo and install it from there:

pip install -e .

Google API credentials are required to create events in the calendar. You can obtain them here. Store credentials.json into a directory accessible by your code.

The library is modifying and deleting calendar events. I highly recommend creating a new calendar to be used by this software: "add calendar" -> "create new calendar" in Google calendar settings.

Usage

See example.py for an example of the potential pipeline that can be run on the regular intervals.

aircal's People

Contributors

domenp avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.