Metadata-Version: 1.0
Name: webhaak
Version: 0.3.0
Summary:  Simple webhook service to update and deploy sites and do other maintenance
Home-page: https://github.com/aquatix/webhaak
Author: Michiel Scholten
Author-email: michiel@diginaut.net
License: Apache
Description-Content-Type: UNKNOWN
Description: webhaak
        =======
        
        |PyPI version| |PyPI downloads| |PyPI license| |Code health|
        
        `webhaak`_ is a simple `webhook`_ service to update and deploy sites and do
        other maintenance without having to ssh to a node.
        
        
        Installation
        ------------
        
        From PyPI
        ~~~~~~~~~
        
        Assuming you already are inside a virtualenv:
        
        .. code-block:: bash
        
            pip install webhaak
        
        From Git
        ~~~~~~~~
        
        Create a new virtualenv (if you are not already in one) and install the
        necessary packages:
        
        .. code-block:: bash
        
            git clone https://github.com/aquatix/webhaak.git
            cd webhaak
            mkvirtualenv webhaak # or whatever project you are working on
            pip install -r requirements.txt
        
        
        Usage
        -----
        
        Copy ``settings.py`` from example_config to the parent directory and
        configure to your needs. Create a yaml file with the projects to serve (see
        next section) and refer to this file from the settings.py.
        
        Run webhaak as a service under nginx or apache and call the appropriate
        url's when wanted (e.g., on push to repository).
        
        Url's are of the form https://hook.example.com/app/<appkey>/<triggerkey>
        
        
        Example configuration
        ---------------------
        
        See the example `hook settings`_ for syntax of how to configure
        repositories, commands and directories.
        
        Call webhaak on its endpoint ``/getappkey`` to generate a random new key for
        usage in the projects yaml file (so, for example https://hook.example.com/getappkey)
        
        By default, webhaak clones projects in a directory under its
        ``REPOS_CACHE_DIR`` directory, but there is support for a per-repo parent dir
        settings with ``repoparent``.
        
        This means that webhaak then doesn't clone this repo into its default cache
        dir, but in a subdirectory of the directory configured in ``repoparent``, so
        <repoparent>/reponame (e.g., /srv/customparent/myproject).
        
        
        Server configuration
        ~~~~~~~~~~~~~~~~~~~~
        
        * `vhost for Apache2.4`_
        * `uwsgi.ini`_
        
        
        What's new?
        -----------
        
        See the `Changelog`_.
        
        
        .. _webhaak: https://github.com/aquatix/webhaak
        .. _webhook: https://en.wikipedia.org/wiki/Webhook
        .. |PyPI version| image:: https://img.shields.io/pypi/v/webhaak.svg
           :target: https://pypi.python.org/pypi/webhaak/
        .. |PyPI downloads| image:: https://img.shields.io/pypi/dm/webhaak.svg
           :target: https://pypi.python.org/pypi/webhaak/
        .. |PyPI license| image:: https://img.shields.io/github/license/aquatix/webhaak.svg
           :target: https://pypi.python.org/pypi/webhaak/
        .. |Code health| image:: https://landscape.io/github/aquatix/webhaak/master/landscape.svg?style=flat
           :target: https://landscape.io/github/aquatix/webhaak/master
           :alt: Code Health
        .. _hook settings: https://github.com/aquatix/webhaak/blob/master/example_config/examples.yaml
        .. _vhost for Apache2.4: https://github.com/aquatix/webhaak/blob/master/example_config/apache_vhost.conf
        .. _uwsgi.ini: https://github.com/aquatix/webhaak/blob/master/example_config/uwsgi.ini
        .. _Changelog: https://github.com/aquatix/webhaak/blob/master/CHANGELOG.md
        
Platform: UNKNOWN
