Gluepy documentation

Everything you need to know about Gluepy.

First steps

Are you new to Gluepy or to programming? This is the place to start!

• From scratch: Overview | Installation

• Tutorial: Part 1: DAGs and Tasks | Part 2: Data managers | Part 3: Context and configuration parameters | Part 4: Custom CLI commands

• Advanced Tutorials: Writing your first patch for Gluepy

Getting help

Having trouble? We’d like to help!

• Try the FAQ – it’s got answers to many common questions.

• Looking for specific information? Try the Index, Module Index or the detailed table of contents.

• Not found anything? See FAQ: Getting Help for information on getting support and asking questions to the community.

• Report bugs with Gluepy in our ticket tracker.

How the documentation is organized

Gluepy has a lot of documentation. A high-level overview of how it’s organized will help you know where to look for certain things:

• Tutorials take you by the hand through a series of steps to create a web application. Start here if you’re new to Gluepy or web application development. Also look at the “First steps”.

• Topic guides discuss key topics and concepts at a fairly high level and provide useful background information and explanation.

• Reference guides contain technical reference for APIs and other aspects of Gluepy’s machinery. They describe how it works and how to use it but assume that you have a basic understanding of key concepts.

Execution Layer

Gluepy provides multiple tools and abstractions related to “Executing” your Machine Learning or Data pipelines both from how to structure the execution, to triggering the execution itself. Learn more about it below:

• DAG: Introduction to DAGs | DAG reference | Task reference

• Commands: Introduction to CLI | dag command | startproject command | startmodule command | airflow generate command

File Layer

Data and file interactions is a primary citizen of the Gluepy framework, and it provides a set of utilities, abstractions and useful tools to interact with the file system and read data.

• Storages: Introduction to Storage | The BaseStorage Class | The LocalStorage Class | The GoogleStorage Class | The S3Storage Class

• Data Managers: Introduction to Data Managers | Data Backends | The PandasDataManager Class | The BaseDataManager Class

The development process

Learn about the various components and tools to help you in the development and testing of Gluepy applications:

• Settings: Overview | Full list of settings

Security

Security is a topic of paramount importance in the development of web applications and Gluepy provides multiple protection tools and mechanisms:

• Security overview

The Gluepy open-source project

Learn about the development process for the Gluepy project itself and about how you can contribute:

• Community: Contributing to Gluepy | Security policies

Indices, glossary and tables

• Index

• Module Index

• Gluepy documentation contents

• Glossary