Quantum Hex.pm VersionBuild Status

Cron-like job scheduler for Elixir applications.

Setup

To use Quantum in your projects, edit your mix.exs file and add Quantum as a dependency:

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

Then, add Quantum to the list of applications in your mix.exs file:

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

Usage

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

config :quantum, cron: [
    "* * * * *": fn -> IO.puts("every minute") end,
    "*/2 * * * *": fn -> IO.puts("every two minutes") end,
    # Runs on 18, 20, 22, 0, 2, 4, 6:
    "0 18-6/2 * * *": fn -> IO.puts("it's late") end,
    # Runs every midnight:
    "@daily": &backup/0
]

Contributing

  1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
  2. Fork the quantum-elixir repository on Github to start making your changes.
  3. Write a test which shows that the bug was fixed or that the feature works as expected.
  4. Send a pull request.

License

Apache License, Version 2.0