Metadata-Version: 2.1
Name: webhooks_git_automata
Version: 0.0.1
Summary: Webhook receiver for Git deployments
Home-page: https://github.com/alexbarcelo/webhooks-git-automata
Author: Alex Barcelo
Author-email: alex@betarho.net
License: UNKNOWN
Description: 
        Webhook receiver for Git deployments
        ====================================
        
        This project started as a dirty & quick hack to perform some deployment actions 
        triggered by a Git webhook.
        
        I looked a little bit at other projects and didn't found any one that suited my 
        needs, so I started this project... and then it grew a little bit and become
        something more versatile than the quick hack originally intended.
        
        This project is aimed at DevOps or sysadmin that have git repositories, typically
        with a VIP-branch, and automatic deployment. You may want to have different branches
        for stage and production or set up push permissions differently to the different 
        branches. This utility, when a webhook is received, will update the local Git repository
        and perform the commands in the settings.
        
        Quickstart
        ----------
        
         - Create and activate a Virtual Environment: 
        ```
        virtualenv --python=/usr/bin/python3 /path/to/venv
        source /path/to/venv/bin/activate
        ```
         - Install the package: `pip install webhooks_git_automata`
         - Create a `settings.yaml` 
         - Set up a service (e.g. a systemd _service_ file) that does something along: 
        ```
        /path/to/venv/bin/wh-gitd /path/to/settings.yaml
        ```
        
        Settings
        --------
        
        
        Implementation details
        ----------------------
        
        This project contains a minimal Flask server that answers the POST webhooks sent 
        by a Git server like GitLab, GitHub or Gogs. The server is started through the 
        Flask's `app.run` method.
        
        Not a lot of traffic is expected, but you may want to set up a reverse proxy in front
        of the Flask server, or add some fancier method like a WSGI or uWSGI or similar layer.
        
        Typical git servers expect the webhook to send a quick reply (in general, HTTP 
        connections are intended to be short lived) so there is a worker/tasks approach. There
        is a very simple implementation base on `Threading` and a shared `Queue`. More complex
        implementations may be added in the future (pull requests welcome).
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
