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.10.1.tar.gz (107.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.10.1-py3-none-any.whl (177.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hyrex-0.10.1.tar.gz
  • Upload date:
  • Size: 107.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.10.1.tar.gz
Algorithm Hash digest
SHA256 fc2fd9070c06198a10aba245fe1541706a78f5185c8ec23f0731815c50ecaf09
MD5 0956e7858b519a8c1646cd3e540753ad
BLAKE2b-256 0a59a6ae3a2aa6d07766fa130ffbe336049181d528fd4988ef66901fd238f3fd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hyrex-0.10.1-py3-none-any.whl
  • Upload date:
  • Size: 177.0 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.10.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4db1fa5f5f32f960439dc99d25ebc05c4198e604c29c5bda2ce0c13c8a0ea666
MD5 a94d3716aba985463f5945d9220db95e
BLAKE2b-256 686c647ce2e557836f4be4f40bf49d490ca5bfc18747ea23f87006f452cec647

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