Packages

quantum

1.9.3
3.5.3 3.5.2 retired 3.5.1 retired 3.5.0 3.4.0 3.3.0 3.2.0 3.1.0 3.0.2 3.0.1 3.0.0 3.0.0-rc.3 3.0.0-rc.2 3.0.0-rc.1 2.4.0 2.3.4 2.3.3 2.3.2 2.3.1 retired 2.3.0 retired 2.2.7 2.2.6 2.2.5 retired 2.2.4 retired 2.2.3 retired 2.2.2 retired 2.2.1 retired 2.2.0 retired 2.1.3 retired 2.1.2 retired 2.1.1 retired 2.1.0 retired 2.1.0-beta.1 retired 2.0.4 retired 2.0.3 retired 2.0.2 retired 2.0.1 retired 2.0.0 retired 2.0.0-beta.2 retired 2.0.0-beta.1 retired 1.9.3 retired 1.9.2 retired 1.9.1 retired 1.9.0 retired 1.8.1 retired 1.8.0 retired 1.7.1 retired 1.7.0 retired 1.6.1 retired 1.6.0 retired 1.5.0 retired 1.4.0 retired 1.3.2 retired 1.3.1 retired 1.3.0 retired 1.2.4 retired 1.2.3 retired 1.2.2 retired 1.2.1 retired 1.2.0 retired 1.1.0 retired 1.0.4 retired 1.0.3 retired 1.0.2 retired 1.0.1 retired 1.0.0 retired

Cron-like job scheduler for Elixir.

Retired package: Security issue - v1 is no longer supported
HexDocs

Current section

Files

Jump to
Readme
66 Versions
2 Dependencies
Dependants
Files
Activity
quantum README.md
Raw

README.md 

# Quantum



[Cron](https://en.wikipedia.org/wiki/Cron)-like job scheduler for [Elixir](http://elixir-lang.org/).



[![Hex.pm Version](http://img.shields.io/hexpm/v/quantum.svg)](https://hex.pm/packages/quantum)

[![Hex docs](http://img.shields.io/badge/hex.pm-docs-green.svg?style=flat)](https://hexdocs.pm/quantum)

[![Build Status](https://travis-ci.org/c-rack/quantum-elixir.svg?branch=master)](https://travis-ci.org/c-rack/quantum-elixir)

[![Coverage Status](https://coveralls.io/repos/c-rack/quantum-elixir/badge.svg?branch=master)](https://coveralls.io/r/c-rack/quantum-elixir?branch=master)

[![Inline docs](http://inch-ci.org/github/c-rack/quantum-elixir.svg)](http://inch-ci.org/github/c-rack/quantum-elixir)

[![Hex.pm](https://img.shields.io/hexpm/dt/quantum.svg)](https://hex.pm/packages/quantum)



## Setup



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



**1. the list of dependencies:**

```elixir

defp deps do

  [{:quantum, ">= 1.9.3"}]

end

```



**2. and the list of applications:**

```elixir

def application do

  [applications: [:quantum]]

end

```



## Usage



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



```elixir

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](https://hexdocs.pm/quantum/configuration.html)



## Contribution



This project uses the [Collective Code Construction Contract (C4)](http://rfc.zeromq.org/spec:42/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](https://github.com/c-rack/quantum-elixir/issues) or [open a new issue](https://github.com/c-rack/quantum-elixir/issues/new) to start a discussion around [a problem](https://www.youtube.com/watch?v=_QF9sFJGJuc).

2. Issues SHALL be named as "Problem: _description of the problem_".

3. Fork the [quantum-elixir repository on GitHub](https://github.com/c-rack/quantum-elixir) 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](https://github.com/c-rack/quantum-elixir/graphs/contributors)



## License



[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)