skip to navigation
skip to content

Not Logged In

sloth-ci 1.3.0

Simple app for automatization of everything

Package Documentation

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 http://sloth-ci.com/ (btw, Sloth CI builds them).

Requirements

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

Install

Install Sloth from PyPI 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

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

api_auth:
    login: admin
    password: supersecret

Start

Start the Sloth CI server with:

$ sloth-ci start

Create App

Create a file called myapp.yml:

listen_point: docs

work_dir: ~/projects

provider:
    bitbucket:
        owner: username
        repo: repository
        branches:
            - master
            - staging

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

params:
    output: /var/www/html

Create the app from the config:

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

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

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

 
File Type Py Version Uploaded on Size
sloth-ci-1.3.0.win-amd64.exe (md5) MS Windows installer any 2015-07-19 140KB
sloth-ci-1.3.0.zip (md5) Source 2015-07-19 19KB
sloth_ci-1.3.0-py3-none-any.whl (md5) Python Wheel 3.5 2015-07-19 17KB
  • Downloads (All Versions):
  • 293 downloads in the last day
  • 4335 downloads in the last week
  • 14015 downloads in the last month