Documentationย ย ย
magical
powers
Give your data team Integrate and synchronize data from 3rd party sources
Build real-time and batch pipelines to transform data using Python, SQL, and R
Run, monitor, and orchestrate thousands of pipelines without losing sleep
Build
Have you met anyone who said they loved developing in Airflow?
Thatโs why we designed an easy developer experience that youโll enjoy.
โ
Preview
Stop wasting time waiting around for your DAGs to finish testing.
Get instant feedback from your code each time you run it.
โ
Launch
Donโt have a large team dedicated to Airflow?
Mage makes it easy for a single developer or small team to scale up and manage thousands of pipelines.
๐ง Intro
Mage is an open-source data pipeline tool for transforming and integrating data.
- Quick start
- Demo
- Tutorials
- Documentation
- Features
- Core design principles
- Core abstractions
- Contributing
๐โโ๏ธ Quick start
You can install and run Mage using Docker (recommended), pip
, or conda
.
Install using Docker
-
Create a new project and launch tool (change
demo_project
to any other name if you want):docker run -it -p 6789:6789 -v $(pwd):/home/src mageai/mageai \ /app/run_app.sh mage start demo_project
- If you want to run Mage locally on a different port, change the first port after
-p
in the command above. For example, to change the port to6790
, run:
docker run -it -p 6790:6789 -v $(pwd):/home/src mageai/mageai \ /app/run_app.sh mage start demo_project
Want to use Spark or other integrations? Read more about integrations.
- If you want to run Mage locally on a different port, change the first port after
-
Open http://localhost:6789 in your browser and build a pipeline.
- If you changed the Docker port for running Mage locally, go to the url
http://127.0.0.1:[port]
(e.g. http://127.0.0.1:6790) in your browser to view the pipelines dashboard.
pip
or conda
Using -
Install Mage
(a) To the current virtual environment:
pip install mage-ai
or
conda install -c conda-forge mage-ai
(b) To a new virtual environment (e.g.,myenv
):python3 -m venv myenv source myenv/bin/activate pip install mage-ai
or
conda create -n myenv -c conda-forge mage-ai conda activate myenv
For additional packages (e.g.
spark
,postgres
, etc), please see Installing extra packages.If you run into errors, please see Install errors.
-
Create new project and launch tool (change
demo_project
to any other name if you want):mage start demo_project
-
Open http://localhost:6789 in your browser and build a pipeline.
๐ฎ Demo
Live demo
Build and run a data pipeline with our demo app.
WARNING
The live demo is public to everyone, please donโt save anything sensitive (e.g. passwords, secrets, etc).
Demo video (2 min)
Click the image to play video
๐ฉโ๐ซ Tutorials
- Load data from API, transform it, and export it to PostgreSQL
- Integrate Mage into an existing Airflow project
- Train model on Titanic dataset
- Set up DBT models and orchestrate DBT runs
๐ฎ Features
Orchestration | Schedule and manage data pipelines with observability. | |
Notebook | Interactive Python, SQL, & R editor for coding data pipelines. | |
Data integrations | Synchronize data from 3rd party sources to your internal destinations. | |
Streaming pipelines | Ingest and transform real-time data. | |
DBT | Build, run, and manage your DBT models with Mage. |
A sample data pipeline defined across 3 files โ
- Load data โ
@data_loader def load_csv_from_file(): return pd.read_csv('default_repo/titanic.csv')
- Transform data โ
@transformer def select_columns_from_df(df, *args): return df[['Age', 'Fare', 'Survived']]
- Export data โ
@data_exporter def export_titanic_data_to_disk(df) -> None: df.to_csv('default_repo/titanic_transformed.csv')
What the data pipeline looks like in the UI โ
New? We recommend reading about blocks and learning from a hands-on tutorial.
๐๏ธ Core design principles
Every user experience and technical design decision adheres to these principles.
Easy developer experience | Open-source engine that comes with a custom notebook UI for building data pipelines. | |
Engineering best practices built-in | Build and deploy data pipelines using modular code. No more writing throwaway code or trying to turn notebooks into scripts. | |
Data is a first-class citizen | Designed from the ground up specifically for running data-intensive workflows. | |
Scaling is made simple | Analyze and process large data quickly for rapid iteration. |
๐ธ Core abstractions
These are the fundamental concepts that Mage uses to operate.
Project | Like a repository on GitHub; this is where you write all your code. |
Pipeline | Contains references to all the blocks of code you want to run, charts for visualizing data, and organizes the dependency between each block of code. |
Block | A file with code that can be executed independently or within a pipeline. |
Data product | Every block produces data after it's been executed. These are called data products in Mage. |
Trigger | A set of instructions that determine when or how a pipeline should run. |
Run | Stores information about when it was started, its status, when it was completed, any runtime variables used in the execution of the pipeline or block, etc. |
๐โโ๏ธ Contributing and developing
Add features and instantly improve the experience for everyone.
Check out the contributing guide to setup your development environment and start building.
๐จโ๐ฉโ๐งโ๐ฆ Community
Individually, weโre a mage.
๐ง MageMagic is indistinguishable from advanced technology. A mage is someone who uses magic (aka advanced technology). Together, weโre Magers!
๐งโโ๏ธ ๐ง Magers (/หmฤjษr/
)A group of mages who help each other realize their full potential! Letโs hang out and chat together โ
For real-time news, fun memes, data engineering topics, and more, join us on โ
GitHub | |
Slack |
๐ค Frequently Asked Questions (FAQs)
Check out our FAQ page to find answers to some of our most asked questions.
๐ชช License
See the LICENSE file for licensing information.