b74a7122d2
The docstrings are currently in the `__init__` method, due to which they are not automatically shown in the Sphinx documentation. |
||
---|---|---|
.github | ||
airflow | ||
dags | ||
dev | ||
docs | ||
licenses | ||
scripts | ||
tests | ||
.codecov.yml | ||
.coveragerc | ||
.editorconfig | ||
.gitignore | ||
.rat-excludes | ||
.readthedocs.yml | ||
.travis.yml | ||
CHANGELOG.txt | ||
CONTRIBUTING.md | ||
DISCLAIMER | ||
INSTALL | ||
LICENSE | ||
MANIFEST.in | ||
NOTICE | ||
README.md | ||
TODO.md | ||
UPDATING.md | ||
init.sh | ||
run_tox.sh | ||
run_unit_tests.sh | ||
setup.cfg | ||
setup.py | ||
tox.ini |
README.md
Airflow
NOTE: The transition from 1.8.0 (or before) to 1.8.1 (or after) requires uninstalling Airflow before installing the new version. The package name was changed from airflow
to apache-airflow
as of version 1.8.1.
Airflow is a platform to programmatically author, schedule, and monitor workflows.
When workflows are defined as code, they become more maintainable, versionable, testable, and collaborative.
Use Airflow to author workflows as directed acyclic graphs (DAGs) of tasks. The Airflow scheduler executes your tasks on an array of workers while following the specified dependencies. Rich command line utilities make performing complex surgeries on DAGs a snap. The rich user interface makes it easy to visualize pipelines running in production, monitor progress, and troubleshoot issues when needed.
Getting started
Please visit the Airflow Platform documentation (latest stable release) for help with installing Airflow, getting a quick start, or a more complete tutorial.
Documentation of GitHub master (latest development branch): ReadTheDocs Documentation
For further information, please visit the Airflow Wiki.
Beyond the Horizon
Airflow is not a data streaming solution. Tasks do not move data from one to the other (though tasks can exchange metadata!). Airflow is not in the Spark Streaming or Storm space, it is more comparable to Oozie or Azkaban.
Workflows are expected to be mostly static or slowly changing. You can think of the structure of the tasks in your workflow as slightly more dynamic than a database structure would be. Airflow workflows are expected to look similar from a run to the next, this allows for clarity around unit of work and continuity.
Principles
- Dynamic: Airflow pipelines are configuration as code (Python), allowing for dynamic pipeline generation. This allows for writing code that instantiates pipelines dynamically.
- Extensible: Easily define your own operators, executors and extend the library so that it fits the level of abstraction that suits your environment.
- Elegant: Airflow pipelines are lean and explicit. Parameterizing your scripts is built into the core of Airflow using the powerful Jinja templating engine.
- Scalable: Airflow has a modular architecture and uses a message queue to orchestrate an arbitrary number of workers. Airflow is ready to scale to infinity.
User Interface
-
DAGs: Overview of all DAGs in your environment.
-
Tree View: Tree representation of a DAG that spans across time.
-
Graph View: Visualization of a DAG's dependencies and their current status for a specific run.
-
Task Duration: Total time spent on different tasks over time.
-
Gantt View: Duration and overlap of a DAG.
-
Code View: Quick way to view source code of a DAG.
Who uses Airflow?
As the Airflow community grows, we'd like to keep track of who is using the platform. Please send a PR with your company name and @githubhandle if you may.
Currently officially using Airflow:
- 6play [@lemourA, @achaussende, @d-nguyen, @julien-gm]
- AdBOOST [AdBOOST]
- Agari [@r39132]
- Airbnb [@mistercrunch, @artwr]
- Airtel [@harishbisht]
- Alan [@charles-go]
- allegro.pl [@kretes]
- AltX [@pedromduarte]
- Apigee [@btallman]
- ARGO Labs [California Data Collaborative]
- Astronomer [@schnie, @andscoop, @tedmiston, @benjamingregory]
- Auth0 [@sicarul]
- Away [@trunsky]
- Azri Solutions [@userimack]
- BalanceHero [@swalloow]
- Banco de Formaturas [@guiligan]
- BandwidthX [@dineshdsharma]
- BBM
- Bellhops
- BelugaDB [@fabio-nukui & @joao-sallaberry & @lucianoviola & @tmatuki]
- BlaBlaCar [@puckel & @wmorin]
- Bloc [@dpaola2]
- Blue Yonder [@blue-yonder]
- BlueApron [@jasonjho & @matthewdavidhauser]
- Bluecore [@JLDLaughlin]
- Boda Telecom Suite - CE [@erssebaggala, @bodastage]
- Bodastage Solutions [@erssebaggala, @bodastage]
- Bonnier Broadcasting [@wileeam]
- BounceX [@JoshFerge, @hudsonrio, @ronniekritou]
- California Data Collaborative powered by ARGO Labs
- Carbonite [@ajbosco]
- Celect [@superdosh & @chadcelect]
- Change.org [@change, @vijaykramesh]
- Checkr [@tongboh]
- Children's Hospital of Philadelphia Division of Genomic Diagnostics [@genomics-geek]
- Cinimex DataLab [@kdubovikov]
- City of San Diego [@MrMaksimize, @andrell81 & @arnaudvedy]
- Clairvoyant @shekharv
- Clover Health [@gwax & @vansivallab]
- Chartboost [@cgelman & @dclubb]
- Collectivehealth Inc. @retornam
- ContaAzul [@bern4rdelli, @renanleme & @sabino]
- Cotap [@maraca & @richardchew]
- Craig@Work
- Credit Karma [@preete-dixit-ck & @harish-gaggar-ck & @greg-finley-ck]
- CreditCards.com[@vmAggies & @jay-wallaby]
- Creditas [@dcassiano]
- Custom Ink [@david-dalisay, @dmartin11 & @mpeteuil]
- Dailymotion [@germaintanguy & @hc]
- Data Reply [@kaxil]
- DataFox [@sudowork]
- Digital First Media [@duffn & @mschmo & @seanmuth]
- DocuTAP [@jshvrsn & @lhvphan & @cloneluke]
- Dotmodus [@dannylee12]
- Drivy [@AntoineAugusti]
- Easy Taxi [@caique-lima & @WesleyBatista & @diraol]
- eRevalue [@hamedhsn]
- evo.company [@orhideous]
- FreshBooks [@DinoCow]
- Fundera [@andyxhadji]
- GameWisp [@tjbiii & @theryanwalls]
- Gentner Lab [@neuromusic]
- Glassdoor [@syvineckruyk]
- Global Fashion Group [@GFG]
- GovTech GDS [@chrissng & @datagovsg]
- Gradeup [@gradeup]
- Grand Rounds [@richddr, @timz1290, @wenever, & @runongirlrunon]
- Groupalia [@jesusfcr]
- Groupon [@stevencasey]
- Gusto [@frankhsu]
- Handshake [@mhickman]
- Handy [@marcintustin / @mtustin-handy]
- HBC Digital [@tmccartan & @dmateusp]
- HBO[@yiwang]
- Healthjump [@miscbits]
- HelloFresh [@tammymendt & @davidsbatista & @iuriinedostup]
- Hipages [@arihantsurana]
- Holimetrix [@thibault-ketterer]
- Hootsuite
- Hostnfly [@CyrilLeMat & @pierrechopin & @alexisrosuel]
- HotelQuickly [@zinuzoid]
- IFTTT [@apurvajoshi]
- iHeartRadio[@yiwang]
- imgix [@dclubb]
- ING
- Intercom [@fox & @paulvic]
- Investorise [@svenvarkel]
- Jampp
- JobTeaser [@stefani75 & @knil-sama]
- Kalibrr [@charlesverdad]
- Karmic [@hyw]
- Kiwi.com [@underyx]
- Kogan.com [@geeknam]
- KPN B.V. [@biyanisuraj & @gmic]
- Lemann Foundation [@fernandosjp]
- LendUp [@lendup]
- LetsBonus [@jesusfcr & @OpringaoDoTurno]
- Liberty Global [@LibertyGlobal]
- liligo [@tromika]
- LingoChamp [@haitaoyao]
- Lucid [@jbrownlucid & @kkourtchikov]
- Lumos Labs [@rfroetscher & @zzztimbo]
- Lyft[@SaurabhBajaj]
- M4U [@msantino]
- Madrone [@mbreining & @scotthb]
- Markovian [@al-xv, @skogsbaeck, @waltherg]
- Mercadoni [@demorenoc]
- Mercari [@yu-iskw]
- MFG Labs
- MiNODES [@dice89, @diazcelsa]
- Multiply [@nrhvyc]
- mytaxi [@mytaxi]
- Nerdwallet
- New Relic [@marcweil]
- Newzoo [@newzoo-nexus]
- Nextdoor [@SivaPandeti, @zshapiro & @jthomas123]
- OdysseyPrime [@davideberdin]
- OfferUp
- OneFineStay [@slangwald]
- Open Knowledge International @vitorbaptista
- Overstock [@mhousley & @mct0006]
- Pandora Media [@Acehaidrey & @wolfier]
- PAYMILL [@paymill & @matthiashuschle]
- PayPal [@r39132 & @jhsenjaliya]
- Pernod-Ricard [@romain-nio]
- Plaid [@plaid, @AustinBGibbons & @jeeyoungk]
- Playbuzz [@clintonboys & @dbn]
- PMC [@andrewm4894]
- Postmates [@syeoryn]
- Pronto Tools [@zkan & @mesodiar]
- Publicis Pixelpark [@feluelle]
- PubNub [@jzucker2]
- Qplum [@manti]
- Quantopian [@eronarn]
- Qubole [@msumit]
- Quizlet [@quizlet]
- Quora
- REA Group
- Reddit [@reddit]
- Robinhood [@vineet-rh]
- Scaleway [@kdeldycke]
- Sense360 [@kamilmroczek]
- Shopkick [@shopkick]
- Sidecar [@getsidecar]
- SimilarWeb [@similarweb]
- SmartNews [@takus]
- SocialCops [@vinayak-mehta & @sharky93]
- Spotahome [@spotahome]
- Spotify [@znichols]
- Stackspace
- Stripe [@jbalogh]
- Strongmind [@tomchapin & @wongstein]
- Tails.com [@alanmcruickshank]
- Thinking Machines [@marksteve]
- Thinknear [@d3cay1, @ccson, & @ababian]
- Thumbtack [@natekupp]
- Tictail
- Tile [@ranjanmanish]
- Tokopedia @topedmaria
- Twine Labs [@ivorpeles]
- T2 Systems [@unclaimedpants]
- Ubisoft [@Walkoss]
- United Airlines [@ilopezfr]
- Upsight [@dhuang]
- Vente-Exclusive.com [@alexvanboxel]
- Vevo [@csetiawan & @jerrygillespie]
- Vidio
- Vnomics [@lpalum]
- WePay [@criccomini & @mtagle]
- WeTransfer [@jochem]
- Whistle Labs [@ananya77041]
- WiseBanyan
- Wooga
- Xero [@yan9yu]
- Xoom
- Yahoo!
- Yieldr [@ggeorgiadis]
- Zapier [@drknexus & @statwonk]
- Zego [@ruimffl]
- Zendesk
- Zenly [@cerisier & @jbdalido]
- Zymergen
- 99 [@fbenevides, @gustavoamigo & @mmmaia]
Who Maintains Airflow?
Airflow is the work of the community, but the core committers/maintainers are responsible for reviewing and merging PRs as well as steering conversation around new feature requests. If you would like to become a maintainer, please review the Apache Airflow committer requirements.