Python client for Phaxio v2 API
Project description
Phaxio
A Python module for interacting with the Phaxio API.
Installation
Via pip:
$ pip install phaxio
Full Documentation
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
- Make changes to spec/api.yaml
- Run make swagger-generate
- Make changes to phaxio/api.py as necessary
- 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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size phaxio-0.3.tar.gz (32.6 kB) | File type Source | Python version None | Upload date | Hashes View |