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.7.tar.gz (57.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.9.7-py3-none-any.whl (75.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hyrex-0.9.7.tar.gz
  • Upload date:
  • Size: 57.5 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.7.tar.gz
Algorithm Hash digest
SHA256 229103a009806c33a88239285abf80deffb3fab03960e8e732af67ec4e7a1cd9
MD5 9188d01d13ac730487b1484967510bb0
BLAKE2b-256 c0295505bd8f47b291a316ea88e43a8121399fe80aaa45be9e455cd610064f6d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hyrex-0.9.7-py3-none-any.whl
  • Upload date:
  • Size: 75.8 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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 60d7361d7a77034c0f86fc72b467de0b0396d1fb2dc698c42af4304d02a73ecf
MD5 b0f48f4d134a04357ba56038d8631a71
BLAKE2b-256 63da1392268eefb089c6543310a50e483608dbf9f692885eef25f7bdcf2d6897

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