Skip to main content

Hyrex is the open-source COLD task orchestration framework built on Postgres.

Project description

hyrex-sdk

Hyrex is a modern, open-source task orchestration framework.

Installation

pip install hyrex

Running on your own infra:

Step 1: Database initialization

  • Set HYREX_DATABASE_URL to your Postgres database connection string
  • Run hyrex init-db

Step 2: Decorate your tasks

  • Instantiate a Hyrex object wherever your tasks are defined:
from hyrex import Hyrex

hy = Hyrex(app_id="my-hyrex-app")
  • Decorate your task:
def NameContext(BaseModel):
    name: str


@hy.task
def say_name(context: NameContext):
    print(context.name)
  • Send your task to the Hyrex queue. A worker will pick it up from there.
say_name.send(NameContext(name="Bob"))

Step 3: Run your worker(s)

  • Make sure HYREX_DATABASE_URL is set.
  • Update this command with the module path to your Hyrex instance:
hyrex run-worker my_app.tasks:hy

Logging

Hyrex uses Python's logging module for logging info about task queueing, worker status, etc. By default, no logs are displayed. To turn on logs, configure this in your application. For example:

import logging
logging.basicConfig(level=logging.INFO)

To configure Hyrex logs only:

logger = logging.getLogger("hyrex")
logger.setLevel(logging.INFO)

Handlers and formatting options from the logging module are also supported.

For worker processes, the logging level can be set using the log-level flag on the hyrex run-worker CLI command.

Project details


Download files

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

Source Distribution

hyrex-0.9.4.tar.gz (54.0 kB view details)

Uploaded Source

Built Distribution

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

hyrex-0.9.4-py3-none-any.whl (66.5 kB view details)

Uploaded Python 3

File details

Details for the file hyrex-0.9.4.tar.gz.

File metadata

  • Download URL: hyrex-0.9.4.tar.gz
  • Upload date:
  • Size: 54.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.13.2

File hashes

Hashes for hyrex-0.9.4.tar.gz
Algorithm Hash digest
SHA256 e1e160ce5f9bbd09a8f59e700c4752371ea33737d7c2e17313b02f1e387d2b18
MD5 01a88cef44e4a609415de0f404118e95
BLAKE2b-256 2dcd2f1a7100afb026ac66ba4448153ed67b08bd721cade694a9c56e8aedb709

See more details on using hashes here.

File details

Details for the file hyrex-0.9.4-py3-none-any.whl.

File metadata

  • Download URL: hyrex-0.9.4-py3-none-any.whl
  • Upload date:
  • Size: 66.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.13.2

File hashes

Hashes for hyrex-0.9.4-py3-none-any.whl
Algorithm Hash digest
SHA256 ea817210dabe4522861f62c0244cd623004cf65144ee635eb134969810d15fc3
MD5 b72cacbf53bb8bb2e204ecf5513b9040
BLAKE2b-256 83065b292a28d0471e5c41e35c094919ae0254cc020c16bc608576feb78f1e0c

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