Python implementation of the PamFax API
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
doc
pamfax
test
CHANGES.txt
ISSUES
LICENSE
MANIFEST
MANIFEST.in
README
doc.zip
setup.py

README

NAME

    pamfaxp - A Python module that implements the PamFax API. 

    For more information about the PamFax API that is used with this module, 
    please see:

        http://www.pamfax.biz/en/extensions/developers/

    As this python module is still in development, please report any bugs or 
    issues by raising an issue here:

        http://github.com/dynaptico/pamfaxp/issues

NOTE ON PYTHON VERSIONS

    This module is for python 2.x and has only been tested against python 2.7.  

INSTALLATION

    The module is available from packages.python.org and can be installed using 
	pip dynaptico-pamfax

TESTS

    Run the test suite with the following commands:

    cd test
    python test.py

LOGGING

    This module uses the built-in Python logging, with the NullHandler added by default. You can override the default logger
    by adding the following code to your application (taken from http://docs.python.org/howto/logging.html):
    
    import logging
    logger = logging.getLogger('pamfax')
    logger.setLevel(logging.DEBUG)
    sh = logging.StreamHandler()
    sh.setLevel(logging.DEBUG)
    formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
    sh.setFormatter(formatter)
    logger.addHandler(sh)

DOCUMENTATION

    The documentation for this package is available at the following location:

        http://packages.python.org/dynaptico-pamfax

    And was generated with the following command (just so I don't forget):

        epydoc --html -o doc --name dynaptico-pamfax --url https://github.com/dynaptico/pamfaxp -v pamfax pamfax.processors

THANKS TO

    Jason Goecke and team at Tropo for writing tropo-webapi-python and
    pamfaxr, both of which this module is heavily based on.

        http://github.com/tropo/pamfaxr
        http://github.com/tropo/tropo-webapi-python