{ "info": { "author": "Octopush", "author_email": "UNKNOWN", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "License :: OSI Approved :: Apache Software License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Topic :: Internet", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "Octopush API Python\n=========================\n\n|Build Status|\n\nA Python library for `Octopush API `__.\n\nOctopush offers a solution that was built in-house as a hosted service (SaaS, Software as a Service and an API)\nto allow marketing departments of major groups, advertising agencies and IT companies to enjoy an infrastructure\nthat supports sending SMS messages to more than 200 countries.\n\nInstallation\n------------\n\nInstall via PyPI\n\n.. code:: shell\n\n pip install octopush\n\nOr add ``octopush`` to your application's `requirements\nfile `__\nand then run\n\n.. code:: shell\n\n pip install -r requirements.txt\n\nOr from source code\n\n.. code:: shell\n\n git clone https://github.com/bearburger/octopush-api-python.git\n cd octopush-api-python\n python setup.py install\n\nUsage\n-----\n\nConfig file (``config.js``)\n~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n.. code:: python\n\n import octopush\n import datetime\n\n config = {\n 'user_login': '*******@*******',\n 'api_key': '****************',\n 'sms_recipients': ['+33600000000'],\n 'sms_text': 'test text ' + datetime.datetime.now().strftime(\"%Y-%m-%d %H:%M\"),\n 'sms_type': octopush.SMS_WORLD,\n 'sms_sender': 'onesender'\n }\n\nBalance check\n~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n.. code:: python\n\n from octopush import SMS\n from config import config\n\n sms = SMS(config['user_login'], config['api_key'])\n\n result = sms.get_balance()\n\n for balance in result.findall('balance'):\n print(balance.attrib['type'], balance.text)\n\nSMS sending\n~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n.. code:: python\n\n from octopush import SMS\n from config import config\n import uuid\n\n sms = SMS(config['user_login'], config['api_key'])\n sms.set_sms_text(config['sms_text'])\n sms.set_sms_recipients(config['sms_recipients'])\n sms.set_sms_type(config['sms_type'])\n sms.set_sms_sender(config['sms_sender'])\n sms.set_sms_request_id(str(uuid.uuid1()))\n\n result = sms.send()\n\n print(result)\n\nMore examples can be found in `Simple Examples`_ and `Advanced Examples`_.\n\nRequirements\n------------\n\n- API key, register at `octopush.com`_ to get one\n- Python 2.6+, 3.5+\n- `python-requests`_\n\nDocumentation\n~~~~~~~~~~~~~\n\nThis library is completely documented using `PyDoc`_ and will show\nautocompletions in all editors that supports it. Alternatively you can\nbuild HTML version of documentation via `pydoc` tool.\n\nAPI documentation available on `Octopush API documentation portal`_.\n\n.. _Simple Examples: examples/simple_examples/\n.. _Advanced Examples: examples/advanced_examples/\n.. _octopush.com: http://www.octopush.com/en/registration\n.. _python-requests: http://docs.python-requests.org/en/master/\n.. _PyDoc: https://docs.python.org/2/library/pydoc.html\n.. _Octopush API documentation portal: http://www.octopush.com/en/api-sms-documentation\n.. |Build Status| image:: https://travis-ci.org/bearburger/octopush-api-python.png?branch=master\n :target: https://travis-ci.org/bearburger/octopush-api-python", "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/bearburger/octopush-api-python", "keywords": "octopush sms", "license": "MIT", "maintainer": null, "maintainer_email": null, "name": "octopush", "package_url": "https://pypi.org/project/octopush/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/octopush/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/bearburger/octopush-api-python" }, "release_url": "https://pypi.org/project/octopush/1.0.0/", "requires_dist": null, "requires_python": null, "summary": "Python library for Octopush API", "version": "1.0.0" }, "last_serial": 1941904, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "96dbc537c5c1a51707c1e84b874f6c38", "sha256": "83136d9a325a8c306aeea2b51356a0b8494d1e447f31c7a0edf044473b39bd72" }, "downloads": -1, "filename": "octopush-1.0.0.zip", "has_sig": false, "md5_digest": "96dbc537c5c1a51707c1e84b874f6c38", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13198, "upload_time": "2016-02-05T17:40:20", "url": "https://files.pythonhosted.org/packages/23/62/4ca11d1fb6ca76061b0c43b5b59e09dc94f895417d801fdc2d5f84bea71b/octopush-1.0.0.zip" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "96dbc537c5c1a51707c1e84b874f6c38", "sha256": "83136d9a325a8c306aeea2b51356a0b8494d1e447f31c7a0edf044473b39bd72" }, "downloads": -1, "filename": "octopush-1.0.0.zip", "has_sig": false, "md5_digest": "96dbc537c5c1a51707c1e84b874f6c38", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13198, "upload_time": "2016-02-05T17:40:20", "url": "https://files.pythonhosted.org/packages/23/62/4ca11d1fb6ca76061b0c43b5b59e09dc94f895417d801fdc2d5f84bea71b/octopush-1.0.0.zip" } ] }