Skip to main content

Unofficial FreedomPop client library

Project description

https://img.shields.io/pypi/v/freedompop.svg https://img.shields.io/pypi/pyversions/freedompop.svg https://img.shields.io/travis/jaraco/freedompop/master.svg Code style: Black

Unofficial FreedomPop Client library, inspired by freedompop-telegram.

This library provides a simple Pythonic API to a selection of calls available through the undocumented and unsupported FreedomPop API.

Configuration

All configuration is solicited through various environment variables.

App Credentials:

  • FREEDOMPOP_API_USERNAME
  • FREEDOMPOP_API_PASSWORD
  • FREEDOMPOP_APP_VERSION

For these, you may extract them from an APK or re-use ones such as those published here.

Account Credentials:

  • FREEDOMPOP_USERNAME
  • FREEDOMPOP_PASSWORD

These are the e-mail address and password used to authenticate to the FreedomPop web site.

Other variables that may be used:

  • FREEDOMPOP_DEVICE_ID
  • FREEDOMPOP_DEVICE_SID
  • FREEDOMPOP_DEVICE_TYPE
  • FREEDOMPOP_RADIO_TYPE
  • FREEDOMPOP_PUSH_TOKEN

Usage

Command-Line

Once installed, the package provides a command-line client. For any of the API methods that require no parameters, you may invoke it from the command line and see the JSON response. For example:

$ python -m freedompop 'get phone account info'
{'accountExternalId': None,
 'accountExternalRefId': '...',
 'accountId': '...',
 ...

The command invoked can use space-separated, dash-separated, or underscore-separated names.

Programmatic

For other applications, it’s possible to construct and invoke the API programmatically:

>>> import freedompop
>>> client = freedompop.Client.from_env()
>>> client.get_phone_account_info()
{...}

Read the docs or review the source for the methods available.

Project details


Download files

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

Files for freedompop, version 1.1.1
Filename, size File type Python version Upload date Hashes
Filename, size freedompop-1.1.1-py2.py3-none-any.whl (5.0 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size freedompop-1.1.1.tar.gz (10.3 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page