sloth-ci 1.0.0

Simple app for automatization of everything

Sloth CI is an easy-to-use, lightweight, extendable tool that executes actions you need when certain events happen.

Sloth CI was created because Jenkins is too heavy and Buildbot was too hard to learn.

Read the docs at sloth-ci.rtfd.org.

Requirements

Sloth CI runs with Python 3 on Windows, Linux, and Mac.

Install

Install Sloth CI with pip:

$ pip install sloth-ci

Configure

Create a file named sloth.yml in any directory and cd to that directory.

Here’s how your sloth.yml can look like:

host: localhost

port: 8080

daemon: true

log_dir: /var/logs/sloth-ci

api_auth:
    login: admin
    password: supersecret

Start

Start the Sloth CI server with:

$ sloth-ci start

Create App

Create a file called like myapp.yml:

listen_point: myapp/incoming

work_dir: ~/projects

provider:
    bitbucket:
        repo: username/repository

extensions:
    error_logs:
        module: logs
        path: /var/logs/sloth-ci/myapp
        filename: myapp_errors.log
        level: ERROR

actions:
    hg pull {branch} -u {repo_dir}
    sphinx-build -aE {repo_dir} {output_dir}

params:
    repo_dir: repository
    output_dir: /var/www/myapp_docs

Create the app from the config:

$ sloth-ci create-app myapp.yml
App created, listening on myapp/incoming

Note

Run sloth-ci create from the directory with the sloth.yml file.

That’s it! Your app now listens for payload from Bitbucket at http://localhost:8080/myapp/incoming.

Create a hook on Bitbucket, and you docs will be automatically built on every push to the repo.