Skip to main content

Simple app for automatization of everything

Project description

Latest Version Downloads Supported Python Versions Wheel Status Development Status

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

Requirements

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

Install

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

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

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 | RSS feed

Download files

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

Source Distribution

sloth-ci-1.2.4.zip (19.3 kB view hashes)

Uploaded Source

Built Distributions

sloth_ci-1.2.4-py3-none-any.whl (17.8 kB view hashes)

Uploaded Python 3

sloth-ci-1.2.4.win-amd64.exe (281.0 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page