Skip to main content

Core ETL pipeline framework for mkpipe.

Project description

MkPipe

MkPipe is a modular, open-source ETL (Extract, Transform, Load) tool that allows you to integrate various data sources and sinks easily. It is designed to be extensible with a plugin-based architecture that supports extractors, transformers, and loaders.

Features

  • Extract data from multiple sources (e.g., PostgreSQL, MongoDB).
  • Transform data using custom Python logic and Apache Spark.
  • Load data into various sinks (e.g., ClickHouse, PostgreSQL, Parquet).
  • Plugin-based architecture that supports future extensions.
  • Cloud-native architecture, can be deployed on Kubernetes and other environments.

Quick Setup

You can deploy MkPipe using one of the following strategies:

1. Using Docker Compose

This method sets up all required services automatically using Docker Compose.

Steps:

  1. Clone or copy the deploy folder from the repository.

  2. Modify the configuration files:

  3. Run the following command to start the services:

    docker-compose up --build
    

    This will set up the following services:

    • PostgreSQL: Required for data storage.
    • RabbitMQ: Required for the Celery run_coordinator=celery.
    • Celery Worker: Required for running the Celery run_coordinator=celery.
    • Flower UI: Optional, but required for monitoring Celery tasks.

    Note: If you only want to use the run_coordinator=singlewithout Celery, only PostgreSQL is necessary.

2. Running Locally

You can also set up the environment manually and run MkPipe locally.

Steps:

  1. Set up and configure the following services:
    • RabbitMQ: Required for the Celery run_coordinator.
    • PostgreSQL: Required for data storage.
    • Flower UI: Optional, but required for monitoring Celery tasks.
  2. Update the following configuration files in the deploy folder:
    • .env for environment variables.
    • mkpipe_project.yaml for your ETL configurations.
  3. Install the python packages
    pip install mkpipe mkpipe-extractor-postgres mkpipe-loader-postgres
    
  4. Set the project directory environment variable:
    export MKPIPE_PROJECT_DIR={YOUR_PROJECT_PATH}
    
  5. Start MkPipe using the following command:
    mkpipe run
    

Documentation

For more detailed documentation, please visit the GitHub repository.

License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details.

Db Support Plan

For actively supported databases/plugins, please visit the MkPipe-hub repository!

Core Relational Databases

  • PostgreSQL
  • MySQL/MariaDB
  • SQL Server
  • Oracle Database
  • SQLite
  • Snowflake
  • Google BigQuery
  • Amazon Redshift
  • ClickHouse
  • Amazon S3

NoSQL Databases

  • MongoDB
  • Cassandra
  • DynamoDB
  • Redis
  • Azure Data Lake Storage (ADLS)
  • Google Cloud Storage
  • Elasticsearch
  • TimescaleDB
  • HDFS
  • InfluxDB

ERP/CRM Systems

  • Salesforce
  • SAP
  • Microsoft Dynamics
  • NetSuite
  • Workday
  • HubSpot
  • Zoho CRM
  • Freshsales
  • Zendesk
  • Oracle NetSuite

Emerging Databases & Analytical Tools

Apache Druid

  • Vertica
  • SingleStore (MemSQL)
  • Exasol
  • SAP HANA
  • IBM Db2
  • Neo4j (Graph Database)
  • Greenplum
  • CockroachDB
  • AWS Athena

Streaming Systems

  • Kafka
  • RabbitMQ
  • Pulsar
  • Apache Flink
  • Amazon Kinesis
  • Google Pub/Sub
  • Azure Event Hubs
  • Apache NiFi
  • ActiveMQ
  • Redpanda

File Formats & Data Lakes

  • Parquet
  • Avro
  • JSON
  • CSV
  • XML
  • ORC
  • Google Drive (for raw files)
  • Dropbox
  • Box
  • FTP/SFTP Servers

Specialized Analytics Tools

  • Metabase (Data Visualization)
  • Tableau Data Extracts
  • Power BI
  • Looker
  • Google Analytics (GA4)
  • Mixpanel
  • Amplitude
  • Adobe Analytics
  • Heap
  • Klipfolio

Industry-Specific Databases

  • Aerospike
  • RocksDB
  • FaunaDB
  • ScyllaDB
  • ArangoDB
  • MarkLogic
  • CrateDB
  • TigerGraph
  • HarperDB
  • SAP ASE (Sybase)

Legacy Databases

  • Teradata
  • Netezza
  • Informix
  • Ingres
  • Firebird
  • Progress OpenEdge
  • ParAccel
  • MaxDB
  • HP Vertica
  • Sybase IQ

Emerging Cloud & Hybrid Databases

  • PlanetScale (MySQL-based)
  • YugabyteDB
  • TiDB
  • OceanBase
  • Citus (PostgreSQL-based)
  • Snowplow Analytics
  • Spanner (Google Cloud)
  • MariaDB ColumnStore
  • CockroachDB Serverless
  • Weaviate (Vector Search)

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkpipe-0.1.18.tar.gz (20.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mkpipe-0.1.18-py3-none-any.whl (22.6 kB view details)

Uploaded Python 3

File details

Details for the file mkpipe-0.1.18.tar.gz.

File metadata

  • Download URL: mkpipe-0.1.18.tar.gz
  • Upload date:
  • Size: 20.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.11.10

File hashes

Hashes for mkpipe-0.1.18.tar.gz
Algorithm Hash digest
SHA256 1efe395dfee32331c6298062b21b3401a1dfec9dfc61082cfd1b8256aa196075
MD5 a317bc56e95de41cf06f6e9da00de778
BLAKE2b-256 391d18c09ef85867113aa4f62e6d81e4f24829f6e70c69ef3a3e113565c87675

See more details on using hashes here.

File details

Details for the file mkpipe-0.1.18-py3-none-any.whl.

File metadata

  • Download URL: mkpipe-0.1.18-py3-none-any.whl
  • Upload date:
  • Size: 22.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.11.10

File hashes

Hashes for mkpipe-0.1.18-py3-none-any.whl
Algorithm Hash digest
SHA256 b22bfab12f85d8188ec7a352a33a9f2224345c8635cc34915b501cebeac4a20d
MD5 6ae7382f8cb7500021e9c120a17111b0
BLAKE2b-256 7b9f952c637d3db058dda9447ae8a7fa373d033fe9e9052d7641339661d609ca

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page