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.6.tar.gz (49.8 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.6-py3-none-any.whl (61.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hyrex-0.8.6.tar.gz
  • Upload date:
  • Size: 49.8 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.6.tar.gz
Algorithm Hash digest
SHA256 5ac12bb71233d677e0f6ac7c928fa774cd82a350a300855861ffcf2b44214a7c
MD5 704c7f289db80d81e37eee75f5dc6396
BLAKE2b-256 9d135505922336d872eb3da3d8882bb19a86d98014144f4deefc6247216f622c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hyrex-0.8.6-py3-none-any.whl
  • Upload date:
  • Size: 61.3 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 fd5240d1e31c144cb8e255dc60e25cc927dd36a87cdd01865ae4c050d388be9c
MD5 4e5f9f10fcaa3f727de7e42c9ca3660a
BLAKE2b-256 c778c25fb80e9b16c65aee4cac9f2d61517f77a65fc26ece9eaeb563fd3aba59

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