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.3.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.3-py3-none-any.whl (61.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hyrex-0.8.3.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.3.tar.gz
Algorithm Hash digest
SHA256 06397dda755d7ec348e3ce14e6d8b65133f68fcbcece32711bc037c4447667f7
MD5 0dd0efc41636d779eae6986e986465d2
BLAKE2b-256 6aea0e34ace79c507a77c82c3827595a7e60517344f5f68e48d77b8281e0a96d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hyrex-0.8.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 dc4bf622e98cffa19d9af303761cea939a227265e335c3a9346a893dfe1e62e2
MD5 b893d57a18e017b142091056cd335474
BLAKE2b-256 f1ab98ff43c3b5b0105fed68e3c919a5d1da4e699ea1896ae537b842b55a6206

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