Skip to main content

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

Metadata

Release files for phaxio 0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for phaxio 0.3
File Size Uploaded
phaxio-0.3.tar.gz 32.6 kB Details

Release files / phaxio-0.3.tar.gz

Download URL phaxio-0.3.tar.gz
Size 32.6 kB
Tags Source
SHA-256 checksum
How to use checksums
c2f316513249233cb2b84d17baa4c8424012833bdc9d78f555bf42249c45b5cf
BLAKE2b-256 checksum
How to use checksums
29a89e2aafe668d9126173c6f8c97acb5b607140a0a8e59ae6becdbb37c87265
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.3 This release

1 release file

0.2

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page