Skip to main content

Provides authentication and row access to Freebox using OS developer API

Project description

freepybox
==========

Easily manage your freebox in Python using the Freebox OS API.
Check your calls, manage your contacts, configure your dhcp, disable your wifi, monitor your LAN activity and many others, on LAN or remotely.

freepybox is a python library implementing the freebox OS API. It handles the authentication process and provides a row access to the freebox API.

Install
-------
Use the PIP package manager
```bash
$ pip install freepybox
```

Or manually download and install the last version from github
```bash
$ git clone https://github.com/fstercq/freepybox.git
$ python setup.py install
```

Get started
-----------
```python
# Import the freepybox package.
from freepybox import Freepybox

# Instantiate the Freepybox class using default options.
fbx = Freepybox()

# Connect to the freebox with default options.
# Be ready to authorize the application on the Freebox.
fbx.open('192.168.0.254')

# Do something usefull, rebooting your freebox for example.
fbx.system.reboot()

# Properly close the session.
fbx.close()
```
Have a look on the example.py for a more complete overview.

Resources
---------
Freebox OS API documentation : http://dev.freebox.fr/sdk/os/

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

freepybox-0.0.2.zip (12.0 kB view details)

Uploaded Source

File details

Details for the file freepybox-0.0.2.zip.

File metadata

  • Download URL: freepybox-0.0.2.zip
  • Upload date:
  • Size: 12.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for freepybox-0.0.2.zip
Algorithm Hash digest
SHA256 65ae62f68f7db2d7ab083b2bedc3e14a4a4af13d3926fc70885bbbc81b546f33
MD5 184f1e66589e85b4681150f140cb5a94
BLAKE2b-256 cc212638401b56b1312473f09e1f35abce8dfa95c9681164ebeaa666cff2eed0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page