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.

Source Distribution

freedompop-1.1.1.tar.gz (10.3 kB view details)

Uploaded Source

Built Distribution

freedompop-1.1.1-py2.py3-none-any.whl (5.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file freedompop-1.1.1.tar.gz.

File metadata

  • Download URL: freedompop-1.1.1.tar.gz
  • Upload date:
  • Size: 10.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.1

File hashes

Hashes for freedompop-1.1.1.tar.gz
Algorithm Hash digest
SHA256 1193646ddb533db59d50ae506e88a04412c3b5da2442ea9a415ecb16fb5e5612
MD5 aad8039aa92777ca1f1ea8ebd8da0387
BLAKE2b-256 cab6b129fb470f3524627cdfa5098651de706ef45c195c7f878c6d1c1a20df51

See more details on using hashes here.

File details

Details for the file freedompop-1.1.1-py2.py3-none-any.whl.

File metadata

  • Download URL: freedompop-1.1.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 5.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.1

File hashes

Hashes for freedompop-1.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 52030879a0e418a6e55253b424da484fddb82cd80745988bd1310e8dc4440c93
MD5 e75f22ddc3cc1a9932242b85fe20aa5d
BLAKE2b-256 96f11ee7c73eefa71c807eea11bc5377e41c466b16099bb3c6a3ca9b0ea90648

See more details on using hashes here.

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