project-capo/amber-python-drivers

View on GitHub
README.md

Summary

Maintainability
Test Coverage
amber-python-drivers
====================

[![Build Status](https://travis-ci.org/project-capo/amber-python-drivers.svg?branch=master)](https://travis-ci.org/project-capo/amber-python-drivers)
[![Codacy Badge](https://www.codacy.com/project/badge/d90b929be42e4593a4ec6bfcc811cd44?style=flat)](https://www.codacy.com/public/pawel/amber-python-drivers)
[![Code Health](https://landscape.io/github/project-capo/amber-python-drivers/master/landscape.svg?style=flat)](https://landscape.io/github/project-capo/amber-python-drivers/master)
[![Coverage Status](https://coveralls.io/repos/project-capo/amber-python-drivers/badge.svg)](https://coveralls.io/r/project-capo/amber-python-drivers)

[![Code Climate](https://codeclimate.com/github/project-capo/amber-python-drivers/badges/gpa.svg)](https://codeclimate.com/github/project-capo/amber-python-drivers)
[![Test Coverage](https://codeclimate.com/github/project-capo/amber-python-drivers/badges/coverage.svg)](https://codeclimate.com/github/project-capo/amber-python-drivers/coverage)
[![Issue Count](https://codeclimate.com/github/project-capo/amber-python-drivers/badges/issue_count.svg)](https://codeclimate.com/github/project-capo/amber-python-drivers)

Requirements
------------

* `python` with `pip` and `virtualenv`
* `protobuf` and `protoc` from `protobuf-compiler`

How to deploy
-------------

* Clone this project.
* Create python virtual environment using `bin/install.sh`.
* Import project to your favorite IDE.

How to use (PyPi)
-----------------

Add to `requirements.txt`

    -e git+git://github.com/project-capo/amber-python-drivers#egg=amber-python-drivers

How to contribute
-----------------

Clone this repo, setup your environment using `bin/install.sh`. Change what you want to change and make pull request.