akissa/pysyncthing

# pysyncthing


## Python bindings for Syncthing REST API

This is a Python port of the [Ruby REST API Bindings](https://github.com/retgoat/syncthing-ruby)
for [Syncthing](http://syncthing.net/)

[![Build Status](https://travis-ci.org/akissa/pysyncthing.svg?branch=master)](https://travis-ci.org/akissa/pysyncthing)
[![Code Climate](https://codeclimate.com/github/akissa/pysyncthing/badges/gpa.svg)](https://codeclimate.com/github/akissa/pysyncthing)
[![codecov](https://codecov.io/gh/akissa/pysyncthing/branch/master/graph/badge.svg)](https://codecov.io/gh/akissa/pysyncthing)
[![Documentation Status](https://readthedocs.org/projects/pysyncthing/badge/?version=latest)](http://pysyncthing.readthedocs.org/en/latest/?badge=latest)
[![MPLv2 License](https://img.shields.io/badge/license-MPLv2-blue.svg?style=flat-square)](https://www.mozilla.org/MPL/2.0/)

## Installation

Install from PyPi

    pip install pysyncthing

Install from Githib

    git clone https://github.com/akissa/pysyncthing.git
    cd pysyncthing
    python setup.py install

## Usage

Documentation is available in the [distribution](https://github.com/akissa/pysyncthing/blob/master/docs/)
as well as on [readthedocs.org](https://pysyncthing.readthedocs.org)

## Contributing

1. Fork it (https://github.com/akissa/pysyncthing/fork)
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request


## License

All code is licensed under the
[MPLv2 License](https://github.com/akissa/pysyncthing/blob/master/LICENSE).