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.8.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.8-py3-none-any.whl (64.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hyrex-0.8.8.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.8.tar.gz
Algorithm Hash digest
SHA256 fd62a58b439172650ee00139c221731b1da948c56a23ee8adeb9d85a79fe82ad
MD5 3b6190153ba684f719f428748416a0da
BLAKE2b-256 8ad8f0cb3561cef0960b2438ae99ceadca81a2ae6b84f31b218495d93a14e12e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hyrex-0.8.8-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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 779a82d75b738043b4efcc1a307dc2d89ab8ad22db3341d5c5b9f6f0dcc08044
MD5 648b7e563bd3a93cf99c1b1fa21c5c34
BLAKE2b-256 ceee47034b5cc31172694692682226695358899a467ae283eafc0d437c719d9c

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