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.4.tar.gz (49.7 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.4-py3-none-any.whl (61.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hyrex-0.8.4.tar.gz
  • Upload date:
  • Size: 49.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for hyrex-0.8.4.tar.gz
Algorithm Hash digest
SHA256 8a884a72a3781c4cde9ae0070334e73a0a604002d1143320bf488f1628e3c2c7
MD5 70f6e070724556848b828789dba4506c
BLAKE2b-256 b311668a5a9f754c81083bdeb312b2c6d8b28f26dc11182345e8270ea79d6cc6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hyrex-0.8.4-py3-none-any.whl
  • Upload date:
  • Size: 61.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for hyrex-0.8.4-py3-none-any.whl
Algorithm Hash digest
SHA256 c3b8c5ea1fc366d083e4da430462c61a41ae460bce6920bff40f88f2c608c364
MD5 dd85a45bc3cc36e4e188f1a91ff0a659
BLAKE2b-256 307bb14af95df0973470fb8d3dd774089175e4b24ba9f436202d27ccdd6cbfa7

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