Metadata-Version: 1.1
Name: sloth-ci
Version: 1.0.1
Summary: Simple app for automatization of everything
Home-page: https://bitbucket.org/moigagoo/sloth-ci
Author: Konstantin Molchanov
Author-email: moigagoo@live.com
License: MIT
Description: ***********************
        Sloth CI: CI for Humans
        ***********************
        
        .. image:: https://pypip.in/version/sloth-ci/badge.svg?style=flat
            :target: https://pypi.python.org/pypi/sloth-ci/
            :alt: Latest Version
        
        .. image:: https://pypip.in/download/sloth-ci/badge.svg?style=flat
            :target: https://pypi.python.org/pypi/sloth-ci/
            :alt: Downloads
        
        .. image:: https://pypip.in/wheel/sloth-ci/badge.svg?style=flat
            :target: https://pypi.python.org/pypi/sloth-ci/
            :alt: Wheel Status
        
        .. image:: https://pypip.in/status/sloth-ci/badge.svg?style=flat
            :target: https://pypi.python.org/pypi/sloth-ci/
            :alt: 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 `sloth-ci.rtfd.org <http://sloth-ci.rtfd.org>`_.
        
        Requirements
        ============
        
        Sloth CI runs with Python 3 on Windows, Linux, and Mac.
        
        Install
        =======
        
        Install Sloth CI with pip:
        
        .. code-block:: bash
        
            $ 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:
        
        .. code-block:: yaml
        
            host: localhost
            
            port: 8080
            
            daemon: true
            
            log_dir: /var/log/sloth-ci
        
            api_auth:
                login: admin
                password: supersecret
        
        Start
        =====
        
        Start the Sloth CI server with:
        
        .. code-block:: bash
        
           $ sloth-ci start
        
        Create App
        ==========
        
        Create a file called like *myapp.yml*:
        
        .. code-block:: yaml
        
            listen_point: myapp/incoming
        
            work_dir: ~/projects
        
            provider:
                bitbucket:
                    repo: username/repository
        
            extensions:
                error_logs:
                    module: logs
                    path: /var/log/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:
        
        .. code-block:: bash
        
            $ 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.
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: Unix
Classifier: Framework :: CherryPy
