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.8.10.tar.gz (51.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.8.10-py3-none-any.whl (64.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hyrex-0.8.10.tar.gz
  • Upload date:
  • Size: 51.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.9

File hashes

Hashes for hyrex-0.8.10.tar.gz
Algorithm Hash digest
SHA256 20527fdd5a5ad56baf8e686433e5de737e089e882dda70c507ee1408a1dc5d07
MD5 d904952b1c1e9894a4c01d07253356fe
BLAKE2b-256 e01db4b83df1e9c1f8b9e8f412d1d008f76f24a712d1b7e751fe8dd36b81bbc3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hyrex-0.8.10-py3-none-any.whl
  • Upload date:
  • Size: 64.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.9

File hashes

Hashes for hyrex-0.8.10-py3-none-any.whl
Algorithm Hash digest
SHA256 87ddd4cac6babb0986fafcda9c32b492d80070ed3806180320f62dac49bc2155
MD5 c2aeafd8027288cf3649f1186dd1c283
BLAKE2b-256 86386d386b4bfa5f660f4e4ab5e1850be4292b934cbd5d1060fd626ffb96d3e7

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