Skip to content
This repository has been archived by the owner on Feb 10, 2022. It is now read-only.

This tools is a Command Line Interface to manage the Freebox V6.

License

Notifications You must be signed in to change notification settings

nlamirault/python-freeboxclient

Repository files navigation

Python Freebox Client

https://badge.fury.io/py/python-freeboxclient.png https://pypip.in/d/python-freeboxclient/badge.png https://travis-ci.org/nlamirault/python-freeboxclient.png https://app.wercker.com/status/3fad72a1bb6196a9ab3093bcf60cf7b4 https://drone.io/github.com/nlamirault/python-freeboxclient/status.png https://coveralls.io/repos/nlamirault/python-freeboxclient/badge.png?branch=master https://gemnasium.com/nlamirault/python-freeboxclient.png

This tools is a Command Line Interface to manage the FreeboxV6

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>

About

This tools is a Command Line Interface to manage the Freebox V6.

Resources

License

Stars

Watchers

Forks

Packages

No packages published