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

Uploaded Python 3

File details

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

File metadata

  • Download URL: hyrex-0.8.9.tar.gz
  • Upload date:
  • Size: 51.5 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.9.tar.gz
Algorithm Hash digest
SHA256 f4d502becf6fac4a9ec1c444be0672fdf5ebf23eb5885cae5268dc65e2d1b293
MD5 b066ca5778425822c7610d782050a6c9
BLAKE2b-256 109720d7b1916daced7ca1b0ed34ca90398f48ca06cb89085fb0d0393e1981b6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hyrex-0.8.9-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.9-py3-none-any.whl
Algorithm Hash digest
SHA256 2305f0d0b679a1d254d0b2ed8e5dc6328a6cd03da724bf26d11837c58f7c720c
MD5 d8edffad25cee107b13f5fd596b588b0
BLAKE2b-256 7ca1146473f205b3d1d36c3891d397752f56fda4c83855232a664dba664f69ac

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