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.12.tar.gz (51.6 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.12-py3-none-any.whl (64.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hyrex-0.8.12.tar.gz
  • Upload date:
  • Size: 51.6 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.12.tar.gz
Algorithm Hash digest
SHA256 2dba46863cb8407e9423320ef931780d3f85f8af78c8067e093c503f6f06de97
MD5 6c4fb67d064017f281588d5930ace16d
BLAKE2b-256 a0179ab9e61cb6705802b1e78a1a196acec369584177ed80c70b060bec3ab06f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hyrex-0.8.12-py3-none-any.whl
  • Upload date:
  • Size: 64.1 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.12-py3-none-any.whl
Algorithm Hash digest
SHA256 15c45aea2f4283606380b2d07b1037225252463dcdff283f6db89f55d3b246d7
MD5 91a9aa99a1b1d55deb8500d808c1d377
BLAKE2b-256 4377ed0b6b9642a730b8c79194ac203d18a2e9015920e4d516145da5f7aca2de

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