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.11.tar.gz (60.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.11-py3-none-any.whl (77.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hyrex-0.9.11.tar.gz
  • Upload date:
  • Size: 60.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.11.tar.gz
Algorithm Hash digest
SHA256 6a23c796b9ee9b50745d73950812f2d14fa03d66b2e6b7c36f1cb63a1445a797
MD5 ecb1a68836f6cc708e65a7fe80b2aadf
BLAKE2b-256 a2b02a0d8593be283fb37c278511672d61b9d03c59fe2ac4586db40a2c6c54cf

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hyrex-0.9.11-py3-none-any.whl
  • Upload date:
  • Size: 77.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.11-py3-none-any.whl
Algorithm Hash digest
SHA256 f489e36108051eef792ac0585677c41348f40befcc02e337f110b7246cd743d1
MD5 326a651a1dcb9d398d0bce2fe04b043b
BLAKE2b-256 43dcd260b8ecc84378ddb5ee7e7b2e0fa7bfba2c23be263c45685bc01a61799e

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