semvec/pypi-packages huggingface dataset:
pyphaxio 0.11
Python client for Phaxio
License: MIT License
Keywords: python phaxio fax api

Phaxio
======

A Python module for interacting with the `Phaxio API`_.

Installation
------------

Via pip:

::

    $ pip install pyphaxio

Usage
-----

Send a fax to multiple people using HTML message:

.. code:: python

    from phaxio import PhaxioApi

    api = PhaxioApi(key, secret)
    r = api.send(to=['4141234567', '5141234567', '6151234567'],
        string_data='Hello World!',
        string_data_type='text')
    print(r.get('faxId'))

Generally, each supported method takes keyword arguments with the exact
same names of the API method parameters as they’re described in the
`documentation`_. One exception to this rule is that ``filename`` is
instead referred to as ``files``. For example, to send a fax using
files:

.. code:: python

    llama = os.path.join(os.path.dirname(__file__), 'tests/llama.pdf')
    alpaca = os.path.join(os.path.dirname(__file__), 'tests/alpaca.pdf')
    f = open(alpaca, 'rb')
    r = api.send(to='4141234567', files=(llama, f))

See the `tests`_ for additional examples.

Error Handling
~~~~~~~~~~~~~~

By default, the api calls return a dictionary. However, you can use
``PhaxioApi(key, secret, raise_errors=True)`` which will raise the
following errors: \* ``AuthenticationError`` - key/secret are invalid \*
``APIError`` - error with api call \* ``ServerError`` - server had an
error and could not complete your request

Errors can be imported from the ``phaxio.exceptions`` module.

Currently Supported API Calls
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Implemented and tested:

-  send
-  testReceive
-  faxStatus
-  faxFile

Implemented and untested:

-  attachPhaxCodeToPdf
-  createPhaxCode
-  getHostedDocument
-  provisionNumber
-  releaseNumber
-  numberList
-  faxList
-  faxCancel
-  accountStatus

Testing
-------

::

    python setup.py test

You will be prompted for a test api key and secret

Contributing
------------

1. Fork it
2. Create your feature branch (``git checkout -b my-new-feature``)
3. Commit your changes (``git commit -am 'Added some feature'``)
4. Push to the branch (``git push origin my-new-feature``)
5. Create new Pull Request

.. _Phaxio API: https://www.phaxio.com/docs
.. _documentation: https://www.phaxio.com/docs
.. _tests: tests/test_api.py