Metadata-Version: 2.4
Name: fastapi-crons
Version: 2.5.0
Summary: Cron scheduling extension for FastAPI with decorators, async support, Hooks, CLI, and SQLite job tracking.
Author-email: Mehar Umar <support@darcode.dev>
License: MIT License
        
        Copyright (c) 2025 Mehar Umar 
        https://darcode.dev
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Project-URL: Homepage, https://github.com/me-umar/fastapi-crons
Project-URL: Documentation, https://crons.darcode.dev
Keywords: fastapi,cron,scheduler,background jobs,tasks,async crons,fastapi crons,crons
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: fastapi>=0.100
Requires-Dist: croniter>=1.3.0
Requires-Dist: aiosqlite>=0.18.0
Requires-Dist: typer[all]>=0.9.0
Requires-Dist: rich
Requires-Dist: redis
Requires-Dist: pydantic>=2.0.0
Requires-Dist: aiohttp
Provides-Extra: dev
Requires-Dist: pytest>=7.0.0; extra == "dev"
Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
Requires-Dist: ruff>=0.1.0; extra == "dev"
Requires-Dist: mypy>=1.0.0; extra == "dev"
Requires-Dist: types-redis; extra == "dev"
Requires-Dist: build>=1.0.0; extra == "dev"
Requires-Dist: httpx>=0.28.1; extra == "dev"
Requires-Dist: twine>=4.0.0; extra == "dev"
Provides-Extra: otel
Requires-Dist: opentelemetry-api>=1.0.0; extra == "otel"
Requires-Dist: opentelemetry-sdk>=1.0.0; extra == "otel"
Provides-Extra: sqlalchemy
Requires-Dist: sqlalchemy[asyncio]>=2.0.47; extra == "sqlalchemy"
Provides-Extra: sqlmodel
Requires-Dist: sqlalchemy[asyncio]>=2.0.47; extra == "sqlmodel"
Requires-Dist: sqlmodel>=0.0.37; extra == "sqlmodel"
Provides-Extra: dashboard
Dynamic: license-file

[![Python CI](https://github.com/me-umar/fastapi-crons/actions/workflows/ci.yml/badge.svg)](https://github.com/me-umar/fastapi-crons/actions/workflows/ci.yml)
[![PyPI - Version](https://img.shields.io/pypi/v/fastapi-crons)](https://pypi.org/project/fastapi-crons/)
[![GitHub Release](https://img.shields.io/github/v/release/me-umar/fastapi-crons)](https://github.com/me-umar/fastapi-crons/releases)

<h1                                                                                                                                                           
                                                                                                                                                                align="center"><strong>FASTAPI-CRONS</strong></h1>


<p align="center"><em>Effortlessly schedule and manage your background tasks.</em></p>

<p align="center">
  <img src="https://img.shields.io/badge/last%20commit-may-informational?style=flat-square" />
  <img src="https://img.shields.io/badge/python-100%25-blue?style=flat-square" />
  <img src="https://img.shields.io/badge/languages-1-blue?style=flat-square" />
</p>

<br/>

<p align="center"><em>Built with the tools and technologies:</em></p>

<p align="center">
  <img src="https://img.shields.io/badge/-Markdown-000000?style=flat-square&logo=markdown" />
  <img src="https://img.shields.io/badge/-Typer-000000?style=flat-square&logo=python" />
  <img src="https://img.shields.io/badge/-TOML-bc4c3f?style=flat-square" />
  <img src="https://img.shields.io/badge/-FastAPI-009688?style=flat-square&logo=fastapi" />
  <img src="https://img.shields.io/badge/-Python-306998?style=flat-square&logo=python" />
  <img src="https://img.shields.io/badge/-AIOHTTP-2c5282?style=flat-square" />
  <img src="https://img.shields.io/badge/-Pydantic-d6336c?style=flat-square" />
</p>

<h1 align="center">FastAPI Crons – Developer Guide</h1>

Welcome to the official guide for using `fastapi_crons`, a high-performance, developer-friendly cron scheduling extension for FastAPI. This library enables you to define, monitor, and control scheduled background jobs using simple decorators and provides CLI tools, web-based monitoring, and SQLite-based job tracking.

---

## 🚀 Features

* Native integration with FastAPI using `from fastapi import FastAPI, Crons`
* Define cron jobs with decorators
* Async + sync job support
* SQLite job state persistence
* CLI for listing and managing jobs
* Automatic monitoring endpoint (`/crons`)
* Named jobs, tags, and metadata
* Easy to plug into any FastAPI project

---

## 📦 Installation

```bash
pip install fastapi-crons
```

That includes the web dashboard. Optional extras add the pluggable backends:

```bash
pip install fastapi-crons[sqlalchemy]  # SQLAlchemy state/lock backends
pip install fastapi-crons[sqlmodel]    # SQLModel state/lock backends
pip install fastapi-crons[otel]        # OpenTelemetry tracing
```

---

## 🛠️ Quick Start

### 1. Setup FastAPI with Crons

```python
from fastapi import FastAPI
from fastapi_crons import Crons, get_cron_router

app = FastAPI()
crons = Crons(app)

# Mount the management endpoints under a prefix. Without one they are served
# from the application root, where `GET /{job_name}` shadows your own routes.
app.include_router(get_cron_router(), prefix="/crons")

@app.get("/")
def root():
    return {"message": "Hello from FastAPI"}

```

### 2. Define Cron Jobs

```python
@crons.cron("*/5 * * * *", name="print_hello")
def print_hello():
    print("Hello! I run every 5 minutes.")

@crons.cron("0 0 * * *", name="daily_task", tags=["rewards"])
async def run_daily_task():
    # Distribute daily rewards or any async task
    await some_async_function()
```
## Cron Expression overview
```bash
┌───────────── minute (0 - 59)
│ ┌───────────── hour (0 - 23)
│ │ ┌───────────── day of the month (1 - 31)
│ │ │ ┌───────────── month (1 - 12)
│ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday)
│ │ │ │ │
* * * * *
```
#### Examples:
- `* * * * *`: Every minute
- `*/15 * * * *`: Every 15 minutes
- `0 * * * *`: Every hour
- `0 0 * * *`: Every day at midnight
- `0 0 * * 0`: Every Sunday at midnight
---

## 🖥️ Cron Monitoring Endpoint

Once included, visit:

```
GET /crons
```

You'll get a full list of jobs with:

* `name`
* `expr` (cron expression)
* `tags`
* `last_run` (from SQLite)
* `next_run`

---

## 📊 Web Dashboard

A prebuilt web UI for browsing jobs and their run history ships with the
package — no extra needed. Mount the cron router and visit `/dashboard`
underneath whatever prefix you chose:

```
GET /dashboard
```

See [`examples/dashboard/app.py`](examples/dashboard/app.py) for a runnable
setup.

> **Note:** the dashboard exposes job names, schedules and run history, and
> ships with no authentication of its own. Put it behind your own auth or
> network controls before mounting it on a public deployment.

---

## 🧩 SQLite Job State Tracking

We use SQLite (via `aiosqlite`) to keep a persistent record of when each job last ran. This allows observability and resilience during restarts.

## 🗄️ SQLAlchemy State Backend

For projects already using SQLAlchemy or SQLModel with PostgreSQL or MySQL,
you can reuse your existing database connection instead of SQLite.
```bash
pip install fastapi-crons[sqlalchemy]
# or
pip install fastapi-crons[sqlmodel]
```
```python
from sqlalchemy.ext.asyncio import create_async_engine
from fastapi_crons import Crons
from fastapi_crons.state.sqlalchemy import SQLAlchemyStateBackend

engine  = create_async_engine("postgresql+asyncpg://user:pass@host/db")
backend = SQLAlchemyStateBackend(engine)
crons   = Crons(app, state_backend=backend)
```

Works with sync engines too:
```python
from sqlalchemy import create_engine
engine  = create_engine("postgresql://user:pass@host/db")
backend = SQLAlchemyStateBackend(engine)
```

### Alembic Integration
```python
# env.py
from fastapi_crons.state.sqlalchemy import cron_metadata
target_metadata = [Base.metadata, cron_metadata]
```

---

## 🔒 SQLAlchemy Lock Backend
```bash
pip install fastapi-crons[sqlalchemy]
```
```python
from fastapi_crons.locking.sqlalchemy import SQLAlchemyLockBackend
from fastapi_crons.locking import DistributedLockManager
from fastapi_crons import CronConfig

engine  = create_async_engine("postgresql+asyncpg://...")
backend = SQLAlchemyLockBackend(engine)
manager = DistributedLockManager(backend, CronConfig())
crons   = Crons(app, lock_manager=manager)
```

For PostgreSQL, advisory locks are available as a lighter alternative (no table required):
```python
from fastapi_crons.locking.sqlalchemy import PostgreSQLAdvisoryLockBackend

backend = PostgreSQLAdvisoryLockBackend(engine)
```

### Table:

```sql
CREATE TABLE IF NOT EXISTS job_state (
    name TEXT PRIMARY KEY,
    last_run TEXT
);
```
### Configuration
By default, job state is stored in a SQLite database named `cron_state.db` in the current directory. You can customize the database path:
```python
from fastapi_crons import Crons, SQLiteStateBackend

# Custom database path
state_backend = SQLiteStateBackend(db_path="/path/to/my_crons.db")
crons = Crons(state_backend=state_backend)
```

---

## 👥 Running Multiple Workers

Every worker registers the same jobs, so when a job becomes due exactly one
worker must execute it. Point all workers at a shared lock backend and that is
guaranteed: each scheduled tick is claimed atomically, and the worker that wins
the claim is the only one that runs it.

```bash
export CRON_ENABLE_DISTRIBUTED_LOCKING=true
export CRON_REDIS_URL=redis://localhost:6379/0
```

```python
# ...or wire a backend explicitly (a URL works, a client is not required)
from fastapi_crons import Crons, CronConfig, DistributedLockManager
from fastapi_crons.locking import RedisLockBackend

config  = CronConfig()
manager = DistributedLockManager(RedisLockBackend(config.redis_url), config)
crons   = Crons(app, lock_manager=manager)
```

No Redis? The SQLAlchemy lock backend coordinates through your existing
database instead:

```python
from fastapi_crons.locking.sqlalchemy import SQLAlchemyLockBackend

manager = DistributedLockManager(SQLAlchemyLockBackend(engine), CronConfig())
```

Two things to know:

* The default `SQLiteStateBackend` is per-machine. Workers spread across hosts
  need Redis or the SQLAlchemy state backend.
* Lock keys are namespaced `fastapi_crons:lock:` so they cannot collide with
  anything else in a shared Redis. Override with `CRON_LOCK_KEY_PREFIX`.

A job that takes longer than its own interval does not queue up: ticks that
elapse while it runs are coalesced, and it resumes at the next scheduled time.

---

## 🧵 Async + Thread Execution

The scheduler supports both async and sync job functions
Jobs can be:

* `async def` → run in asyncio loop
* `def` → run safely in background thread using `await asyncio.to_thread(...)`

---

## 🧪 CLI Support

```bash
# List all registered jobs
fastapi-crons list

# Manually run a specific job
# -i imports the module that registers your jobs (repeatable)
fastapi-crons run-job <job_name> -i myapp.jobs

# Show overall system status
fastapi-crons status

# Inspect / change configuration
fastapi-crons config-show
fastapi-crons config-set <key> <value>

# Run the scheduler outside of a FastAPI app
fastapi-crons start-scheduler -i myapp.jobs

# See every command and its options
fastapi-crons --help
```

>

---
## 🧩 Advanced Features

* Distributed locking via Redis
* Retry policies
* Manual run triggers via HTTP
* Admin dashboard with metrics

### Job Tags

You can add tags to jobs for better organization:
```python
@cron_job("*/5 * * * *", tags=["maintenance", "cleanup"])
async def cleanup_job():
    # This job has tags for categorization
    pass
```

---

## ⚙️ Architecture Overview

```
FastAPI App
│
├── Crons()
│   ├── Registers decorated jobs
│   ├── Starts background scheduler (async)
│
├── SQLite Backend
│   ├── Tracks last run for each job
│
├── /crons endpoint
│   ├── Shows current job status (with timestamps)
│
└── CLI Tool
    ├── List jobs / Run manually
```

---

## 🧠 Contributing

We welcome PRs and suggestions! If you'd like this added to FastAPI officially, fork the repo, polish it, and submit to FastAPI with a clear integration proposal.

---

## 🛡️ Error Handling

* Each job has an isolated error handler
* Errors are printed and don't block scheduler
* Future: Add error logging / alert hooks

---

## 📄 License

[Licence](LICENSE)

---

#### Need help? Reach out:
[Email me](mailto:support@darcode.dev)

[github](https://github.com/me-umar)

## Read Documentation at:
[Documentation](https://crons.darcode.dev)
---
## 💬 Credits

Made with ❤️ by Mehar Umar.  
Designed to give developers freedom, flexibility, and control when building production-grade FastAPI apps.

---
