Install

• Install Python tools:

$ apt-get install python-pip
$ pip install virtualenvwrapper
$ source /usr/local/bin/virtualenvwrapper.sh

• Install dependencies :

$ mkvirtualenv freeboxclient
New python executable in python-freeboxclient/bin/python
Installing Setuptools..................done.
Installing Pip.........................done.
$ pip install -r requirements.txt

Development

• Unit tests using Tox

$ tox

• Code coverage:

$ tox -ecoverage

Documentation

This documentation is written by contributors, for contributors. The source is maintained in the doc/source folder using reStructuredText and built by Sphinx

Building Manually:

$ sphinx-build -b html doc/source build/sphinx/html

Results are in the build/sphinx/html directory.

Documentation is available at: http://readthedocs.org/docs/python-freeboxclient/en/latest

Contribute

1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.

2. Fork the repository on GitHub to start making your changes to the master branch (or branch off of it).

3. Write a test which shows that the bug was fixed or that the feature works as expected.

4. Send a pull request and bug the maintainer until it gets merged and published. :)

5. Make sure to add yourself to AUTHORS.

ChangeLog

A changelog is available ChangeLog.

Contact

Nicolas Lamirault <nicolas.lamirault@gmail.com>