Quantum

Cron-like job scheduler for Elixir.

Hex.pm Version Hex docs Build Status Coverage Status Inline docs Hex.pm

Setup

To use Quantum in your project, edit the mix.exs file and add Quantum to both

1. the list of dependencies:

defp deps do
  [{:quantum, ">= 1.9.1"}]
end

2. and the list of applications:

def application do
  [applications: [:quantum]]
end

Usage

Configure your cronjobs in your config/config.exs like this:

config :quantum, :your_app,
  cron: [
    # Every minute
    "* * * * *":      {"Heartbeat", :send},
    # Every 15 minutes
    "*/15 * * * *":   fn -> System.cmd("rm", ["/tmp/tmp_"]) end,
    # Runs on 18, 20, 22, 0, 2, 4, 6:
    "0 18-6/2 * * *": fn -> :mnesia.backup('/var/backup/mnesia') end,
    # Runs every midnight:
    "@daily":         &Backup.backup/0
  ]

More details on the usage can be found in the Documentation

Contribution

This project uses the Collective Code Construction Contract (C4) for all code changes.

“Everyone, without distinction or discrimination, SHALL have an equal right to become a Contributor under the terms of this contract.”

tl;dr

  1. Check for open issues or open a new issue to start a discussion around a problem.
  2. Issues SHALL be named as “Problem: description of the problem”.
  3. Fork the quantum-elixir repository on GitHub to start making your changes
  4. If possible, write a test which shows that the problem was solved.
  5. Send a pull request.
  6. Pull requests SHALL be named as “Solution: description of your solution
  7. Your pull request is merged and you are added to the list of contributors

License

Apache License, Version 2.0