kedro README

The project's README from github.com/kedro-org/kedro. As one markdown file: README.md.

Kedro

Python version PyPI version Conda version License Slack Organisation Slack Archive GitHub Actions Workflow Status - Main GitHub Actions Workflow Status - Develop Documentation OpenSSF Best Practices Monthly downloads Total downloads

Powered by Kedro

What is Kedro?

Kedro is a toolbox for production-ready data engineering and data science pipelines. It uses software engineering best practices to help you create data engineering and data science pipelines that are reproducible, maintainable, and modular. You can find out more at kedro.org.

Kedro is an open-source Python framework hosted by the LF AI & Data Foundation.

How do I install Kedro?

To install Kedro from the Python Package Index (PyPI) run:

uv pip install kedro

It is also possible to install Kedro using conda:

conda install -c conda-forge kedro

Our Get Started guide contains full installation instructions, and includes how to set up Python virtual environments.

Installation from source

To access the latest Kedro version before its official release, install it from the main branch.

uv pip install git+https://github.com/kedro-org/kedro@main

What are the main features of Kedro?

Feature What is this?
Project Template A standard, modifiable and easy-to-use project template based on Cookiecutter Data Science.
Data Catalog A series of lightweight data connectors used to save and load data across many different file formats and file systems, including local and network file systems, cloud object stores, and HDFS. The Data Catalog also includes data and model versioning for file-based systems.
Pipeline Abstraction Automatic resolution of dependencies between pure Python functions and data pipeline visualisation using Kedro-Viz.
Coding Standards Test-driven development using pytest, produce well-documented code using Sphinx, create linted code with support for ruff and make use of the standard Python logging library.
Flexible Deployment Deployment strategies that include single or distributed-machine deployment as well as additional support for deploying on Argo, Prefect, Kubeflow, AWS Batch, and Databricks.

How do I use Kedro?

The Kedro documentation first explains how to install Kedro and then introduces key Kedro concepts.

You can then review the spaceflights tutorial to build a Kedro project for hands-on experience.

For new and intermediate Kedro users, there's a comprehensive section on how to visualise Kedro projects using Kedro-Viz.

A pipeline visualisation generated using Kedro-Viz

Additional documentation explains how to work with Kedro and Jupyter notebooks, and there are a set of advanced user guides for advanced for key Kedro features. We also recommend the API reference documentation for further information.

Why does Kedro exist?

Kedro is built upon our collective best-practice (and mistakes) trying to deliver real-world ML applications that have vast amounts of raw unvetted data. We developed Kedro to achieve the following:

Find out more about how Kedro can answer your use cases from the product FAQs on the Kedro website.

The humans behind Kedro

The Kedro product team and a number of open source contributors from across the world maintain Kedro.

Can I contribute?

Yes! We welcome all kinds of contributions. Check out our guide to contributing to Kedro.

Where can I learn more?

There is a growing community around Kedro. We encourage you to ask and answer technical questions on Slack and bookmark the Linen archive of past discussions.

We keep a list of technical FAQs in the Kedro documentation and you can find a growing list of blog posts, videos and projects that use Kedro over on the awesome-kedro GitHub repository. If you have created anything with Kedro we'd love to include it on the list. Just make a PR to add it!

How can I cite Kedro?

If you're an academic, Kedro can also help you, for example, as a tool to solve the problem of reproducible research. Use the "Cite this repository" button on our repository to generate a citation from the CITATION.cff file.

Python version support policy

☕️ Kedro Coffee Chat 🔶

We appreciate our community and want to stay connected. For that, we offer a public Coffee Chat format where we share updates and cool stuff around Kedro once every two weeks and give you time to ask your questions live.

Check out the upcoming demo topics and dates at the Kedro Coffee Chat wiki page.

Follow our Slack announcement channel to see Kedro Coffee Chat announcements and access demo recordings.

kedro (kedro-org/kedro)

Searching Database…

11K ·GitHub
What is this?Kedro is an open-source Python framework for building production-ready data engineering and data science pipelines, using software engineering best practices to make them reproducible, maintainable, and modular.
Is this a framework I build my project on, or a standalone app?It is a framework: you scaffold a project from a standard Cookiecutter-based template, then write Python functions that Kedro wires into pipelines via automatic dependency resolution.
Do I need anything else before starting, like Jupyter or a specific Python version?Just Python — Kedro supports all Python versions still actively maintained by CPython core, dropping support once a version reaches end of life. Jupyter notebook integration is supported but optional.
Does the separate Kedro Datasets package follow the same Python support as core Kedro?No — kedro-datasets generally drops Python version support earlier than the core framework because its many dependencies follow a more conservative NEP 29 policy.
What is the Data Catalog feature?It is a set of lightweight data connectors for saving and loading data across many file formats and systems (local, network, cloud object stores, HDFS), with built-in versioning for file-based data and models.
How do I visualize my pipeline?Kedro-Viz automatically generates a visualisation of your pipeline's dependency graph, and is recommended for new and intermediate users to understand their Kedro projects.
Where can I deploy a Kedro pipeline?Kedro supports single-machine or distributed deployment, with additional support for Argo, Prefect, Kubeflow, AWS Batch, and Databricks.
Where should I start learning Kedro?The docs walk through installation and key concepts, then the spaceflights tutorial lets you build a real Kedro project hands-on.
Creator
kedro-org
Size
245.7 MB
Stars
11K
Age
7y
Commits · 90 Days