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.3.tar.gz (111.0 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.3-py3-none-any.whl (187.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hyrex-0.10.3.tar.gz
  • Upload date:
  • Size: 111.0 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.3.tar.gz
Algorithm Hash digest
SHA256 e7285177016e490eab326f9d1c12112b73b4966c721b762cbf1f823519c06b94
MD5 23e983a4eaab049c014399ec765e84fb
BLAKE2b-256 90af74f75532f6e0bce58e6fa01efde89a2d3cd647e9fbb5276cc9c57ed867cb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hyrex-0.10.3-py3-none-any.whl
  • Upload date:
  • Size: 187.7 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 bc2a525357901dc12e1b1b78b843ec826eddcc648f682b1a972d6de76bdc6a80
MD5 bdaefc16df01faae4883e9c18d226a34
BLAKE2b-256 b00b8f5e902985e37dbf90467dd2232206c5d00c0bc428c94914f7f1ed3c9ea2

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