{ "info": { "author": "Chris Brown", "author_email": "chris.brown@nwyc.com", "bugtrack_url": null, "classifiers": [], "description": "=======\nWestFax\n=======\n\nA Python implementation of the WestFax API (http://westfax.com/)\n\nUsage requires a WestFax account.\n\nUsage\n-----\n\n.. code-block:: python\n\n\twf = new westfax.WestFax( username, password, product )\n\twf.add_number('555-555-5555')\n\twf.set_header('This is a fax')\n\twf.set_job_name('My fax job')\n\twf.set_content(\"Yah! I'm a fax message!\")\n\n\ttry:\n\t\twf.send()\n\texcept westfax.FaxFail:\n\t\tprint \"Failed to send\"\n\n\nMethods\n-------\n\n`add_number( number )`\n======================\n\nAdds a number to the send the fax to. Mulitple numbers can be added.\n``send()`` will raise ``westfax.NoRecipients`` if no valid numbers are found.\n\n`set_billing_code( billing_code )`\n==================================\n\nSets an optional billing code to track billing for the message in the WestFax dashboard\n\n`set_job_name( name )`\n======================\n\nSets an optional job name to identify the message in the WestFax dashboard\n\n`set_header( header )`\n======================\n\nSets the top header on the fax. (Sent with the fax. Often a company name or subject message)\n\n`set_content( content )`\n========================\n\nText or HTML content of the message. \n``send()`` will raise ``westfax.MissingFaxContent`` if no content was added to the message.\n\n`send()`\n========\n\nSend the message to all recipients. If WestFax returns anything other than a 200 status then\n``send()`` will raise ``westfax.FaxFail``\n\nExceptions\n----------\n\nAll exceptions are raised on ``send()``\n\n`NoRecipients`\n==============\n\nRaised when no numbers were added.\n\n`MissingFaxContent`\n===================\n\nRaised when no content was added to the fax message\n\n`FaxFail`\n=========\n\nRaised when the WestFax API returns anything other than a 200 status.\nThe error message is returned as the exception message.\n\nTODO\n----\n\n* verify phone number validity on ``add_number()``\n* Parse the error message from WestFax to raise more useful exceptions\n\nAUTHOR\n------\n\nConstituentVoice opensource@constituentvoice.com\n\nCOPYRIGHT\n---------\n\nCopyright (c) 2014 Constituent Voice LLC\n\nThis software is provided under the terms of the BSD License. \nIt is free to redistribute and modify so long as this copyright notice is maintained.\nThe software is provided \"AS-IS\" with no warranty. See LICENSE.txt for details.\n\n\"WestFax\" is a trademark of WestFax Inc. use of this software requires valid WestFax API\ncredentials and agreement with WestFax Inc.'s terms of service.\n\nConstituentVoice LLC is not affiliated or partnered with WestFax Inc.", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/constituentvoice/WestFax", "keywords": null, "license": "BSD", "maintainer": null, "maintainer_email": null, "name": "WestFax", "package_url": "https://pypi.org/project/WestFax/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/WestFax/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/constituentvoice/WestFax" }, "release_url": "https://pypi.org/project/WestFax/0.1.2/", "requires_dist": null, "requires_python": null, "summary": "Python wrapper for the WestFax API", "version": "0.1.2" }, "last_serial": 1214511, "releases": { "0.1.1": [], "0.1.2": [ { "comment_text": "", "digests": { "md5": "9a493e10102aa093196070605c1550f4", "sha256": "36e38e9dae3f4b05a90d1287376eb0b804a5dcd1686279a4f851d55b6ca23401" }, "downloads": -1, "filename": "WestFax-0.1.2.tar.gz", "has_sig": false, "md5_digest": "9a493e10102aa093196070605c1550f4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3476, "upload_time": "2014-09-05T18:20:41", "url": "https://files.pythonhosted.org/packages/9d/76/f90f87197806cdecd77567a8c70d922d2829f24a64502dade4e2a0c11e67/WestFax-0.1.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "9a493e10102aa093196070605c1550f4", "sha256": "36e38e9dae3f4b05a90d1287376eb0b804a5dcd1686279a4f851d55b6ca23401" }, "downloads": -1, "filename": "WestFax-0.1.2.tar.gz", "has_sig": false, "md5_digest": "9a493e10102aa093196070605c1550f4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3476, "upload_time": "2014-09-05T18:20:41", "url": "https://files.pythonhosted.org/packages/9d/76/f90f87197806cdecd77567a8c70d922d2829f24a64502dade4e2a0c11e67/WestFax-0.1.2.tar.gz" } ] }