> ## Documentation Index
> Fetch the complete documentation index at: https://hyrex.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Quick Start
> Get started with the Hyrex Python SDK
Get up and running with Hyrex in minutes.
## Prerequisites
* Python 3.11 or higher
* PostgreSQL 12+ (for FOSS) or Hyrex Cloud account
## 1. Install Hyrex
```bash theme={null}
pip install hyrex
```
## 2. Initialize a New Project
Use the interactive `hyrex init` command to set up a new project:
```bash theme={null}
hyrex init
```
This will guide you through:
* Choosing a project name
* Selecting between PostgreSQL (self-hosted) or Hyrex Cloud
* Creating project files (`.env`, `hyrex_app.py`, `tasks.py`, `requirements.txt`, `Dockerfile`)
For manual database initialization (if needed):
```bash theme={null}
export HYREX_DATABASE_URL="postgresql://user:password@localhost/dbname"
hyrex init-db
```
## 3. Project Structure
After running `hyrex init`, you'll have:
```
your-project/
├── .env # Environment configuration
├── hyrex_app.py # Hyrex app configuration
├── tasks.py # Task definitions
├── requirements.txt # Python dependencies
└── Dockerfile # Container configuration
```
Example `tasks.py`:
```python theme={null}
from hyrex import HyrexRegistry
from pydantic import BaseModel
hy = HyrexRegistry()
class EmailContext(BaseModel):
to: str
subject: str
body: str
@hy.task
def send_email(context: EmailContext):
print(f"Sending email to {context.to}")
# Your email logic here
return {"sent": True}
```
## 4. Send Tasks
Queue tasks for execution:
```python theme={null}
# Send a task to the default queue
task = send_email.send(EmailContext(
to="user@example.com",
subject="Welcome!",
body="Thanks for signing up"
))
print(f"Task queued with ID: {task.id}")
# Send with custom configuration
task = send_email.with_config(
queue="high-priority",
max_retries=3,
timeout_seconds=30
).send(EmailContext(
to="user@example.com",
subject="Urgent!",
body="Important message"
))
```
## 5. Run Workers
Start workers to process tasks:
```bash theme={null}
hyrex run-worker hyrex_app:app
```
## 6. Monitor Tasks
Visit your dashboard at [hyrex.io/cloud](https://hyrex.io/cloud) to monitor tasks in real-time.
Run Hyrex Studio locally:
```bash theme={null}
hyrex studio
```
Open [https://local.hyrex.studio](https://local.hyrex.studio) in your browser.
## Next Steps
Learn about task configuration
Build complex workflows
See real-world patterns
Deploy to production