Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/spotify/luigi

Luigi is a Python module that helps you build complex pipelines of batch jobs. It handles dependency resolution, workflow management, visualization etc. It also comes with Hadoop support built in.
https://github.com/spotify/luigi

hadoop luigi orchestration-framework python scheduling

Last synced: 3 days ago
JSON representation

Luigi is a Python module that helps you build complex pipelines of batch jobs. It handles dependency resolution, workflow management, visualization etc. It also comes with Hadoop support built in.

Awesome Lists containing this project

README 

        
.. figure:: https://raw.githubusercontent.com/spotify/luigi/master/doc/luigi.png

   :alt: Luigi Logo

   :align: center



.. image:: https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fspotify%2Fluigi%2Fbadge&label=build&logo=none&%3Fref%3Dmaster&style=flat

    :target: https://actions-badge.atrox.dev/spotify/luigi/goto?ref=master



.. image:: https://img.shields.io/codecov/c/github/spotify/luigi/master.svg?style=flat

    :target: https://codecov.io/gh/spotify/luigi?branch=master



.. image:: https://img.shields.io/pypi/v/luigi.svg?style=flat

   :target: https://pypi.python.org/pypi/luigi



.. image:: https://img.shields.io/pypi/l/luigi.svg?style=flat

   :target: https://pypi.python.org/pypi/luigi



.. image:: https://readthedocs.org/projects/luigi/badge/?version=stable

    :target: https://luigi.readthedocs.io/en/stable/?badge=stable

    :alt: Documentation Status



Luigi is a Python (3.7, 3.8, 3.9, 3.10, 3.11, 3.12 tested) package that helps you build complex

pipelines of batch jobs. It handles dependency resolution, workflow management,

visualization, handling failures, command line integration, and much more.



Getting Started

---------------



Run ``pip install luigi`` to install the latest stable version from `PyPI

`_. `Documentation for the latest release

`__ is hosted on readthedocs.



Run ``pip install luigi[toml]`` to install Luigi with `TOML-based configs

`__ support.



For the bleeding edge code, ``pip install

git+https://github.com/spotify/luigi.git``. `Bleeding edge documentation

`__ is also available.



Background

----------



The purpose of Luigi is to address all the plumbing typically associated

with long-running batch processes. You want to chain many tasks,

automate them, and failures *will* happen. These tasks can be anything,

but are typically long running things like

`Hadoop `_ jobs, dumping data to/from

databases, running machine learning algorithms, or anything else.



There are other software packages that focus on lower level aspects of

data processing, like `Hive `__,

`Pig `_, or

`Cascading `_. Luigi is not a framework to

replace these. Instead it helps you stitch many tasks together, where

each task can be a `Hive query `__,

a `Hadoop job in Java `_,

a  `Spark job in Scala or Python `_,

a Python snippet,

`dumping a table `_

from a database, or anything else. It's easy to build up

long-running pipelines that comprise thousands of tasks and take days or

weeks to complete. Luigi takes care of a lot of the workflow management

so that you can focus on the tasks themselves and their dependencies.



You can build pretty much any task you want, but Luigi also comes with a

*toolbox* of several common task templates that you use. It includes

support for running

`Python mapreduce jobs `_

in Hadoop, as well as

`Hive `__,

and `Pig `__,

jobs. It also comes with

`file system abstractions for HDFS `_,

and local files that ensures all file system operations are atomic. This

is important because it means your data pipeline will not crash in a

state containing partial data.



Visualiser page

---------------



The Luigi server comes with a web interface too, so you can search and filter

among all your tasks.



.. figure:: https://raw.githubusercontent.com/spotify/luigi/master/doc/visualiser_front_page.png

   :alt: Visualiser page



Dependency graph example

------------------------



Just to give you an idea of what Luigi does, this is a screen shot from

something we are running in production. Using Luigi's visualiser, we get

a nice visual overview of the dependency graph of the workflow. Each

node represents a task which has to be run. Green tasks are already

completed whereas yellow tasks are yet to be run. Most of these tasks

are Hadoop jobs, but there are also some things that run locally and

build up data files.



.. figure:: https://raw.githubusercontent.com/spotify/luigi/master/doc/user_recs.png

   :alt: Dependency graph



Philosophy

----------



Conceptually, Luigi is similar to `GNU

Make `_ where you have certain tasks

and these tasks in turn may have dependencies on other tasks. There are

also some similarities to `Oozie `_

and `Azkaban `_. One major

difference is that Luigi is not just built specifically for Hadoop, and

it's easy to extend it with other kinds of tasks.



Everything in Luigi is in Python. Instead of XML configuration or

similar external data files, the dependency graph is specified *within

Python*. This makes it easy to build up complex dependency graphs of

tasks, where the dependencies can involve date algebra or recursive

references to other versions of the same task. However, the workflow can

trigger things not in Python, such as running

`Pig scripts `_

or `scp'ing files `_.



Who uses Luigi?

---------------



We use Luigi internally at `Spotify `_ to run

thousands of tasks every day, organized in complex dependency graphs.

Most of these tasks are Hadoop jobs. Luigi provides an infrastructure

that powers all kinds of stuff including recommendations, toplists, A/B

test analysis, external reports, internal dashboards, etc.



Since Luigi is open source and without any registration walls, the exact number

of Luigi users is unknown. But based on the number of unique contributors, we

expect hundreds of enterprises to use it. Some users have written blog posts

or held presentations about Luigi:



* `Spotify `_ `(presentation, 2014) `__

* `Foursquare `_ `(presentation, 2013) `__

* `Mortar Data (Datadog) `_ `(documentation / tutorial) `__

* `Stripe `_ `(presentation, 2014) `__

* `Buffer `_ `(blog, 2014) `__

* `SeatGeek `_ `(blog, 2015) `__

* `Treasure Data `_ `(blog, 2015) `__

* `Growth Intelligence `_ `(presentation, 2015) `__

* `AdRoll `_ `(blog, 2015) `__

* 17zuoye `(presentation, 2015) `__

* `Custobar `_ `(presentation, 2016) `__

* `Blendle `_ `(presentation) `__

* `TrustYou `_ `(presentation, 2015) `__

* `Groupon `_ / `OrderUp `_ `(alternative implementation) `__

* `Red Hat - Marketing Operations `_ `(blog, 2017) `__

* `GetNinjas `_ `(blog, 2017) `__

* `voyages-sncf.com `_ `(presentation, 2017) `__

* `Open Targets `_ `(blog, 2017) `__

* `Leipzig University Library `_ `(presentation, 2016) `__ / `(project) `__

* `Synetiq `_ `(presentation, 2017) `__

* `Glossier `_ `(blog, 2018) `__

* `Data Revenue `_ `(blog, 2018) `_

* `Uppsala University `_ `(tutorial) `_   / `(presentation, 2015) `_ / `(slides, 2015) `_ / `(poster, 2015) `_ / `(paper, 2016) `_ / `(project) `_

* `GIPHY `_ `(blog, 2019) `__

* `xtream `__ `(blog, 2019) `__

* `CIAN `__ `(presentation, 2019) `__



Some more companies are using Luigi but haven't had a chance yet to write about it:



* `Schibsted `_

* `enbrite.ly `_

* `Dow Jones / The Wall Street Journal `_

* `Hotels.com `_

* `Newsela `_

* `Squarespace `_

* `OAO `_

* `Grovo `_

* `Weebly `_

* `Deloitte `_

* `Stacktome `_

* `LINX+Neemu+Chaordic `_

* `Foxberry `_

* `Okko `_

* `ISVWorld `_

* `Big Data `_

* `Movio `_

* `Bonnier News `_

* `Starsky Robotics `_

* `BaseTIS `_

* `Hopper `_

* `VOYAGE GROUP/Zucks `_

* `Textpert `_

* `Tracktics `_

* `Whizar `_

* `xtream `__

* `Skyscanner `_

* `Jodel `_

* `Mekar `_

* `M3 `_

* `Assist Digital `_

* `Meltwater `_

* `DevSamurai `_

* `Veridas `_



We're more than happy to have your company added here. Just send a PR on GitHub.



External links

--------------



* `Mailing List `_ for discussions and asking questions. (Google Groups)

* `Releases `_ (PyPI)

* `Source code `_ (GitHub)

* `Hubot Integration `_ plugin for Slack, Hipchat, etc (GitHub)



Authors

-------



Luigi was built at `Spotify `_, mainly by

`Erik Bernhardsson `_ and

`Elias Freider `_.

`Many other people `_

have contributed since open sourcing in late 2012.

`Arash Rouhani `_ was the chief maintainer from 2015 to 2019, and now

Spotify's Data Team maintains Luigi.