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.6.tar.gz (62.5 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.6-py3-none-any.whl (79.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hyrex-0.9.6.tar.gz
  • Upload date:
  • Size: 62.5 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.6.tar.gz
Algorithm Hash digest
SHA256 15e9b323e91b28287ba58cd72ba859cb7e0cc8b32153da1e67432d4cc70f2138
MD5 7159ddafbca56bec90082ecc5eb0cdee
BLAKE2b-256 dc7f098384a087db3d80792cb2bdb71760d2b6432efbcd62f24ce4097871db6b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hyrex-0.9.6-py3-none-any.whl
  • Upload date:
  • Size: 79.8 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 6fb61a54ad8186d8baba8c2e663715cf47bcf5a349d33404165cf77a35f6514a
MD5 a7d46b01297f763a6baae3aa3263828a
BLAKE2b-256 7ba5d50908b2f2834ada24ab8b60c78aed55d7e8cb59397facf93ad46f75eb83

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