Skip to main content

Simple app for automatization of everything

Project description

Latest Version Downloads License

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 (yes, they are built with Sloth CI).


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


Install Sloth with pip:

$ pip install sloth-ci

It’s also a good idea to install a validator for Bitbucket or GitHub right away:

$ pip install sloth-ci.validators.bitbucket
$ pip install sloth-ci.validators.github


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

    login: admin
    password: supersecret


Start the Sloth CI server with:

$ sloth-ci start

Create App

Create a file called myapp.yml:

listen_point: docs

work_dir: ~/projects

        owner: username
        repo: repository
            - master
            - staging

    - rm -rf repository
    - hg clone
    - hg up {branch} --cwd repository
    - pip3 install -U sphinx
    - pip3 install -r repository/docs/requirements.txt
    - sphinx-build -aE repository/docs/ {output}/{branch}

    output: /var/www/html

Create the app from the config:

$ sloth-ci create /path/to/myapp.yml
App created, listening on docs


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://yourdomain:8080/docs.

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

Project details

Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
sloth_ci-1.2.9-py3-none-any.whl (17.9 kB) Copy SHA256 hash SHA256 Wheel 3.5 (143.0 kB) Copy SHA256 hash SHA256 Windows Installer any (19.5 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page