https://github.com/mightyscollins/dramatiq-apscheduler

https://github.com/mightyscollins/dramatiq-apscheduler

apscheduler dramatiq rabbitmq

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/mightyscollins/dramatiq-apscheduler
• Owner: MightySCollins
• License: mit
• Created: 2019-07-16T14:55:17.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-02-18T10:03:37.000Z (almost 5 years ago)
• Last Synced: 2024-11-05T21:40:17.005Z (about 2 months ago)
• Topics: apscheduler, dramatiq, rabbitmq
• Language: Python
• Size: 26.4 KB
• Stars: 10
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Dramatiq ApScheduler

Allows simple command line usage of ApScheduler to add tasks directly to Dramatiq. It is designed to support multiple concurrent scheduler process such as in the case of Elastic Beanstalk.

You can run multiple process and each one will check if it's the leader before executing any tasks.

## Requirements

The application uses rabbitmq and redis.

By default both rabbitmq and redis will just use localhost but on most systems you are running these services on another server. You can configure both redis and rabbitmq by providing the connection urls as options `redis_url` and `rabbitmq` or environment variables `SCHEDULE_REDIS_URL` and `SCHEDULE_RABBITMQ`.

## Config

Below is a minimal example of the config. To add more tasks just simply edit the `jobs` config option.  

 

```yaml

jobs:

  trigger_feed_run_every_10_minutes:

    func: run_feeds

    crontab: "*/10 * * * *"

  trigger_test_task:

    func: test_task

    crontab: "*/1 * * * *"

    queue_name: test

```

### Triggers

Currently only one trigger is supported `crontab`. We recommend you use https://crontab.guru/ to validate your expressions.

## Usage

Just run the task to start the process. You can also add the `--debug` flag to get extra logging.

```

Usage: dramatiq_apscheduler [OPTIONS] TASK_FILE

Options:

  --debug           Enables debug logging

  --rabbitmq TEXT   rabbitmq connection url: amqp://127.0.0.1:5672/

  --redis_url TEXT  redis connection url: redis://localhost/

  --expire INTEGER  How long the lock should last for

  --help            Show this message and exit.

```

You can run with the demo config:

    dramatiq_apscheduler config.yaml

    

## Development

The easiest way to develop this application is in a venv. You can see more details in the [click documentation](https://click.palletsprojects.com/en/7.x/setuptools/) but if your venv is setup just run the below command.

 

     pip install --editable .

## Dockerfile

A [docker image](https://hub.docker.com/r/scollins/dramatiq-apscheduler) is also provided which allows you to easily run the application anywhere.

    docker pull scollins/dramatiq-apscheduler

    docker run scollins/dramatiq-apscheduler