Adding integrations

Ordeq is designed to integrate seamlessly with the other tooling. The level of integration can vary from examples in the documentation to fully-fledged extensions that are maintained as part of the Ordeq repository.

Here are the different levels of integrations, from least to most integrated:

1. User customizations: Implemented and maintained in the users' own codebases.

   • Examples: custom IOs or hooks.

2. Documented examples: Integrations that are documented in the Ordeq documentation.

   • Examples: Streamlit and Docker integration guide.

3. IO extensions: Integrations that extend the IO packages of Ordeq.

   • Examples: ordeq-pandas, ordeq-polars. See the packages overview.

4. Framework extensions: Integrations that extend framework functionality of Ordeq.

   • Examples: ordeq-viz and ordeq-cli-runner. See the packages overview.

5. Core framework: Reusable components that are added to the Ordeq core framework.

   • Examples: hooks.

When deciding the level of integration, we evaluate the following criteria:

• Generality: Is the integration useful for a broad audience?
• Community interest: Is there a demand or interest from the community for this integration?
• Complexity: How much complexity does the integration add to the codebase?
• Maintenance: Can we maintain the integration over time?

A favourable score on these criteria results in a higher level of integration.

Not sure where to start?

If you're unsure about the appropriate level of integration for your use case, please reach out to us on GitHub