Python client for Phaxio fax service.
Clone or download
Pull request Compare This branch is 48 commits ahead, 1 commit behind jfialkoff:master.
Latest commit 6a3aa16 Sep 6, 2017

README.rst

Phaxio

PyPI GitHub license

A Python module for interacting with the Phaxio API.

Installation

Via pip:

$ pip install phaxio

Full Documentation

http://phaxio-python.readthedocs.io/en/latest/

Usage

Send a fax to multiple people using HTML message:

from phaxio import PhaxioApi

api = PhaxioApi(key, secret)
response = api.Fax.send(to=['4141234567', '5141234567', '6151234567'],
    files='/path/to/supported/file.pdf')
print(response.data.id)

The full set of Phaxio APIs is available and split into functional groups:

api.Fax

api.PhoneNumber

api.PhaxCode

api.Account

api.Countries

Generally, each supported method takes keyword arguments with the exact same names of the API method parameters as they’re described in the Phaxio documentation.

See the tests for additional examples, or the full documentation.

Error Handling

Errors will cause an ApiException, with fields for HTTP status code, reponse headers, and json response data in the body.

Testing

export API_KEY="MY_API_KEY"
export API_SECRET="MY_API_SECRET"
python setup.py test

Contributing

Making API changes

  1. Make changes to spec/api.yaml
  2. Run make swagger-generate
  3. Make changes to phaxio/api.py as necessary
  4. Update documentation if necessary
  • docs/source/phaxio.rst will probably not require updates unless it's a very big change
  • docs/source/models.rst will require updates only if there are new model types