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, logs are displayed at the INFO level. To adjust the logging level or disable logs, configure this in your application. For example:

import logging
# To change to DEBUG level
logging.basicConfig(level=logging.DEBUG)

# To disable logs
logging.getLogger("hyrex").setLevel(logging.CRITICAL)

To configure Hyrex logs only:

logger = logging.getLogger("hyrex")
# Change log level
logger.setLevel(logging.DEBUG)
# Or disable logs
logger.setLevel(logging.CRITICAL)

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.15.tar.gz (62.2 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.15-py3-none-any.whl (77.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for hyrex-0.9.15.tar.gz
Algorithm Hash digest
SHA256 aeb3230e92e02c2ac64641395abaa39c017d198cdeb80cf8785c821127c8383e
MD5 22c593e787fa4e726f43734ddc7578ef
BLAKE2b-256 687cce494923753ed7d93f9a9a3db50d13e9a70a1bcb05f1456019357e1ffe4f

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for hyrex-0.9.15-py3-none-any.whl
Algorithm Hash digest
SHA256 79e28ae2d9d88f4c3a458312fe5f4ba8874432d2ddc2ec7cae3bdd9f2a882b84
MD5 07f5a1594a27fca9b5830f145050fcf4
BLAKE2b-256 686c18e66a852d0aee44e34db53d457f362310d25255b1cf8dd4cc674c9108ee

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