Skip to main content

oleander-kedro

Public Python package for declaring Oleander metadata on standard Kedro pipelines. Requires Python >=3.10 and Kedro >=1.7,<1.8. Intended for distribution on PyPI; it has no Oleander SDK or cloud dependencies.

Author pipelines

Add this package to your Kedro project's dependencies, then decorate pipeline factories:

from kedro.pipeline import node, pipeline
from oleander_kedro import run_as, schedule


@run_as("sales-pipeline@iam.application.oleander.dev")
@schedule(cron="0 * * * *", timezone="UTC")
def create_pipeline(**kwargs):
    return pipeline([node(print, "params:message", None, name="print_message")])

Register pipelines using the usual register_pipelines() function, optionally calling find_pipelines(raise_errors=True). Authors use conventional Kedro:

uv run kedro run --pipelines orders

This package installs no command or Kedro hooks. Normal kedro run executes ordinary Kedro pipelines without applying schedules, selecting identities, or injecting intervals. Kedro's catalog and parameter behavior remains unchanged. Decorators still validate their arguments and factory return types; invalid declarations fail early.

Declarations

  • @schedule(cron=..., timezone=...) requires basic five-field cron syntax: numeric fields with *, ,, -, and /, plus an explicit IANA timezone. For example, 0 9 * * 1-5 runs on weekdays at 09:00. Named months/weekdays and extensions such as L5, L, W, #, H, R, and ? are rejected at declaration time, as are macros, seconds, and year expressions. Whitespace is normalized. Croniter validates field values and expression structure; its day-of-month/day-of-week convention is OR. Oleander's scheduler must use the same interpretation. Ranges must be ascending: use 22-23,0-2 instead of 22-2 for hours that cross midnight. List entries must not repeat or overlap values, including overlaps introduced by steps. Sunday may be 0 or 7, but 0,7 is a duplicate. A single full-week range such as 0-7 remains valid.
  • @run_as(email) requires one email address. UUIDs, principal names, display names, and address lists are rejected. Surrounding whitespace is stripped and the address is lowercased and normalized to match Oleander's email convention. Validation checks syntax locally, without DNS queries or delivery checks. It declares the desired principal for scheduled execution only. It grants no permissions and never changes the identity of a manual run. The example application-principal email is a placeholder; it need not exist for local tests.
  • Either decorator order works. Duplicate declarations are errors. Factories preserve their signatures, names, and docstrings and return ordinary Kedro Pipeline objects.
  • Metadata belongs to the exact returned object. Copying, composing, filtering, or namespacing a pipeline does not carry declarations forward. Decorate the factory returning the final scheduled pipeline.

Oleander's private discovery/runtime validates the complete registry: pipelines must declare both decorators or neither, and the same scheduled object cannot appear under multiple registry names. Undecorated pipelines are discoverable and can be run manually. Conventional Kedro does not enforce these Oleander registry rules.

The deployment service must resolve the declared email to an existing principal within the organization linked to the GitHub installation, authorize the repository-to-principal binding, and store the resolved UUID with the deployment. Missing, ambiguous, or unauthorized principals must fail deployment. Scheduled runs use that stored UUID so email changes cannot silently change the execution identity. This resolution and authorization belongs to Oleander's service; neither Python package performs it. Principal membership and access must be rechecked at execution time.

Metadata API

Private platform tools read metadata through the public, side-effect-free API:

from oleander_kedro import get_pipeline_metadata

metadata = get_pipeline_metadata(create_pipeline())
print(metadata.schedule.cron)
print(metadata.run_as)

The returned Declaration and nested Schedule are frozen dataclasses. Declaration.run_as contains the normalized email string. Undecorated pipelines return a Declaration with both fields set to None. ConfigurationError subclasses ValueError.

Development

From this directory:

uv sync --locked
uv run pytest
uv run ruff check .
uv run ruff format --check .
uv build

.python-version selects Python 3.10. Tests cover declaration validation and real kedro run invocations with plain Python nodes and no SDK credentials.

From the repository root, also run the cross-language cron compatibility tests:

uv sync --locked --project kedro/oleander-kedro-cli
yarn exec vitest run workflows/kedro/manifest-compatibility.test.ts

These tests require the repository's Node dependencies and uv. They use the same cron fixtures as the Python tests, generate manifests with the actual Python decorators and CLI, and validate them with the TypeScript worker's parseManifest(). No cloud services are involved.

The separate private CLI project depends on this package and owns discovery, runtime interval injection, and the oleander-kedro command. It is not part of this distribution.

Publishing

The publishing workflow builds and publishes this extension when changes under kedro/oleander-kedro-ext/ reach main. It uses the existing GitHub Actions PYPI_TOKEN secret and skips already-published artifacts, following the Python SDK's release pattern.

To release a new version, update version in pyproject.toml and refresh this project's uv.lock. Update the private CLI's exact extension dependency and its lockfile to the same version, then merge to main. The builder release workflow also rebuilds its bundled packages when these directories change. The private CLI is not published to PyPI.

Metadata

Release files for oleander-kedro 0.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for oleander-kedro 0.0.1
File Size Uploaded Provenance Actions
oleander_kedro-0.0.1.tar.gz 64.6 kB Without provenance Details for oleander_kedro-0.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for oleander-kedro 0.0.1
File Interpreter ABI Platform Actions
oleander_kedro-0.0.1-py3-none-any.whl Python 3 none any Details for oleander_kedro-0.0.1-py3-none-any.whl

Total release size: 71.3 kB

Release files / oleander_kedro-0.0.1.tar.gz

Download URL oleander_kedro-0.0.1.tar.gz
Size 64.6 kB
Tags Source
SHA-256 checksum
How to use checksums
743e6ffa41c8cb271070c5ad92130f626764848125b57e37ad6cba56bfe621b0
BLAKE2b-256 checksum
How to use checksums
cf531e83edfee49037530fa6348ffd818299c7aaf65a6ec248ea80c8b4235ba8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.16

Release files / oleander_kedro-0.0.1-py3-none-any.whl

Download URL oleander_kedro-0.0.1-py3-none-any.whl
Size 6.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1bc8fbbea73e09865a07566581adc8578a70c6338fa50685c6dd73bd4043c85a
BLAKE2b-256 checksum
How to use checksums
16754f728453b65d8188fe197fc893d71ded3c8f8cf97684cdf0843ec64af7d9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.16

Security for oleander-kedro 0.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page