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.9.10.tar.gz (60.1 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.10-py3-none-any.whl (77.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for hyrex-0.9.10.tar.gz
Algorithm Hash digest
SHA256 d53cd76eccfb37c9d1f4b0a245cd67eb9a256ffa0acec681d361650514ce4b07
MD5 864a5b2f69af1d15ff188e4145d85ad6
BLAKE2b-256 d0201580a26026101385261a02889ec5915b78a405b4af63c1ba9560499cabb6

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for hyrex-0.9.10-py3-none-any.whl
Algorithm Hash digest
SHA256 c0082a1778da70e7ba3b754eb5ade472fbb79d1a29c9e5e2b05624f3ed6553e0
MD5 a0856b592f19039a88fcce9e27e8e78b
BLAKE2b-256 b46de20391e42e87d385a5ad9dfc3997390009718efbbebf536ba564d24031b8

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