Shitekiq

Welcome to Shitekiq. Like Sidekiq, but with less features.

Backend for background processing jobs.

Installation

Add this line to your application's Gemfile:

gem 'shitekiq'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install shitekiq

Usage with rails

For Rails, create a shitekiq.rb initializer file and set your backend and pool size:

  Shitekiq.configure do |config|
    config.pool_size = 3 # default to 5
    config.backend = Shitekiq::Backend::Redis.new # default to ruby Queue.new
  end

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/julienpierlot/shitekiq.

License

The gem is available as open source under the terms of the MIT License.