Skip to main content

freedompop

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

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.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

freedompop-1.1.0-py2.py3-none-any.whl (5.1 kB view hashes)

Uploaded Python 2 Python 3

Supported by

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