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.9.tar.gz (60.6 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.9-py3-none-any.whl (77.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hyrex-0.9.9.tar.gz
  • Upload date:
  • Size: 60.6 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.9.tar.gz
Algorithm Hash digest
SHA256 acb4b5e81754e2c8e407a9fb14e0ccc41fd9b0aab485caefc76bba0169005424
MD5 71ee7907c4c925aada3ebc28d9dff050
BLAKE2b-256 d85f84ef4b56120c4a87c21524559bc26ed54fb8b8bbdd4ddc4eaa337b08d09d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hyrex-0.9.9-py3-none-any.whl
  • Upload date:
  • Size: 77.9 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.9-py3-none-any.whl
Algorithm Hash digest
SHA256 a95cda22e87c35417bf82b24ea4ca4cd143c27182ab283afdb0bde00d1c80cb9
MD5 40ae178ee71b0b37b2943bba366342e3
BLAKE2b-256 338f548eb04c4607356db39e7f619bed8b689da92b40b5ded7e126e2fb57446e

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