{ "info": { "author": "John-Paul Jorissen", "author_email": "jjorissen52@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: Apache Software License", "Operating System :: Microsoft :: Windows :: Windows 10", "Operating System :: POSIX :: Linux", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Topic :: Office/Business" ], "description": "\nWelcome to ``echo_api``'s documentation!\n========================================\n\nThis project is a work in progress, and contributions are encouraged. If\nyou have questions feels free to contact me at\n`jjorissen52@gmail.com `__\n\nInstallation\n============\n\npip install echo_api\n\nConfiguration\n=============\n\nSecrets\n=======\n\n``echo_api`` is configured to take credentials from a file named\n``echo.conf`` that is expected by default in your working directory.\n``echo.conf`` should look like:\n\n.. sourcecode:: python\n\n [echo]\n username = UserName\n password = Password\n wsdl_location = /path/to/wsdl.xml\n endpoint = https://cloud.echooneappcloud.com/yourorganizationname/OneAppWebService\n\nIf you want ``echo.conf`` to be somewhere other than your project\ndirectory, you will need to set it the location using an environment\nvariable.\n\n.. sourcecode:: python\n\n # Linux\n export INTERFACE_CONF_FILE=/absolute/path/to/conf_file.conf #name doesn't matter\n \n # Or set in Python before you import echo_api\n import os\n os.environ[\"INTERFACE_CONF_FILE\"] = '/absolute/path/to/conf_file.conf'\n\nNote that you must have credentials for a user that has access to the\nAPI before you can proceed.\n\nSOAP API WSDL Definition\n========================\n\nDue to the possibility of some configuration issues on Echo's side, you\nwill need to manually inspect the XML describing the API and ensure that\nthe endpoint definition is correct. Copy and paste this into the address\nbar on your browser (you will need to change it to be your\norganization):\n\nhttps://cloud.echooneappcloud.com/yourorganization/OneAppWebService.svc?singleWsdl\n\nCopy and paste the XML response into an XML file (``wsdl.xml``) in your\nproject directory and scroll all the way to the bottom until you see:\n\n.. sourcecode:: python\n\n \n \n \n \n\nYou will want to change\n\n.. sourcecode:: python\n\n \n\nto\n\n.. sourcecode:: python\n\n \n\nOnce you've set up your wsdl and secrets files, test your connection.\nFor a secrets file that will remain in your project directory, simply\nuse:\n\n.. sourcecode:: python\n\n from echo_api import api\n # Connection() will log you in if everything is correctly configured.\n connection = api.BaseConnection()\n connection.session_id\n\n\n\n\n.. parsed-literal::\n\n '61d63ecc7571430a9ead84dfc7f6301d'\n\n\n\nIf you see a string like the one above, it means that a connection was\nsuccessfully established and you've got the hard part done...\n\n.. sourcecode:: python\n\n connection.API_Logout()\n\n\n\n\n.. parsed-literal::\n\n 'LoggedOut|kathleen.reynolds'\n\n\n\nUsage\n=====\n\nThe ``BaseConnection`` object has all of the API definitions provided by\nthe WSDL file. The API documentation can be found at\n`read the docs. `__\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/jjorissen52/echo_api", "keywords": "ECHO Python API SOAP", "license": "Apache", "maintainer": "", "maintainer_email": "", "name": "echo_api", "package_url": "https://pypi.org/project/echo_api/", "platform": "", "project_url": "https://pypi.org/project/echo_api/", "project_urls": { "Homepage": "https://github.com/jjorissen52/echo_api" }, "release_url": "https://pypi.org/project/echo_api/1.0.7.dev0/", "requires_dist": null, "requires_python": "", "summary": "Python API for Echo credentialing software", "version": "1.0.7.dev0" }, "last_serial": 4012979, "releases": { "1.0.0.dev0": [ { "comment_text": "", "digests": { "md5": "bd62479103199b18108bc9de84ecb4e3", "sha256": "17632fa724f9b89d6163a97eaa515b6332250a1d5f3a7ce7b8b0fd383c1c39f3" }, "downloads": -1, "filename": "echo_api-1.0.0.dev0.tar.gz", "has_sig": false, "md5_digest": "bd62479103199b18108bc9de84ecb4e3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3734, "upload_time": "2017-08-18T14:09:08", "url": "https://files.pythonhosted.org/packages/c3/c1/47aa687b6312a9848f2c0acfcb00147296e5e67d35a52ee3456f797f5c7d/echo_api-1.0.0.dev0.tar.gz" } ], "1.0.3.dev0": [ { "comment_text": "", "digests": { "md5": "edec433fbe9fcecba30a70bbbbbe67f2", "sha256": "80b3ec64780d276c017122d2bfae9ee96ddcd6248eb24a4b77c8bb2e66b34930" }, "downloads": -1, "filename": "echo_api-1.0.3.dev0.tar.gz", "has_sig": false, "md5_digest": "edec433fbe9fcecba30a70bbbbbe67f2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11623, "upload_time": "2017-09-28T19:11:48", "url": "https://files.pythonhosted.org/packages/2e/56/e89b90e3ce1bce91c3c7c0a8e2139e6d0f04edad2b68017b7f3ed6f47b30/echo_api-1.0.3.dev0.tar.gz" } ], "1.0.5.dev0": [ { "comment_text": "", "digests": { "md5": "cef5948fc6fc1d3789e5964619c90b63", "sha256": "5c4b0e2dd98176b937c07590ed5dffe65fb5bc46a8098f519b34b6d52ecbe0df" }, "downloads": -1, "filename": "echo_api-1.0.5.dev0.tar.gz", "has_sig": false, "md5_digest": "cef5948fc6fc1d3789e5964619c90b63", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12136, "upload_time": "2018-02-06T23:18:42", "url": "https://files.pythonhosted.org/packages/a7/ea/94dbf5cdc22d1ce7dba64c3b349a6682b4e451a3571e0b974be6d940cdd6/echo_api-1.0.5.dev0.tar.gz" } ], "1.0.6.dev0": [ { "comment_text": "", "digests": { "md5": "11a88b3e157804e570ab81c0cedb4980", "sha256": "90e31a095610a7c8b0e56fea78d6acf70381a09ca79ae0113a6772ce1545020b" }, "downloads": -1, "filename": "echo_api-1.0.6.dev0.tar.gz", "has_sig": false, "md5_digest": "11a88b3e157804e570ab81c0cedb4980", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12155, "upload_time": "2018-02-23T16:07:53", "url": "https://files.pythonhosted.org/packages/1a/fb/ab8e46636f6f70e31ab016c79507d45c65cba053b9dd83520b83d3cabfe4/echo_api-1.0.6.dev0.tar.gz" } ], "1.0.7.dev0": [ { "comment_text": "", "digests": { "md5": "3f4417ad24a3ec13c5e706a536feea6b", "sha256": "066be5d3b126d85a3dfcac3fc5ac14ff14699d5c48164d117a70d9bdf0edd7bf" }, "downloads": -1, "filename": "echo_api-1.0.7.dev0.tar.gz", "has_sig": false, "md5_digest": "3f4417ad24a3ec13c5e706a536feea6b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12674, "upload_time": "2018-06-28T21:47:03", "url": "https://files.pythonhosted.org/packages/a0/12/4dc397ae5b7ef203d75194bed2eabab86b4f4ddb9da5ddbc2cba27a42a2b/echo_api-1.0.7.dev0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "3f4417ad24a3ec13c5e706a536feea6b", "sha256": "066be5d3b126d85a3dfcac3fc5ac14ff14699d5c48164d117a70d9bdf0edd7bf" }, "downloads": -1, "filename": "echo_api-1.0.7.dev0.tar.gz", "has_sig": false, "md5_digest": "3f4417ad24a3ec13c5e706a536feea6b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12674, "upload_time": "2018-06-28T21:47:03", "url": "https://files.pythonhosted.org/packages/a0/12/4dc397ae5b7ef203d75194bed2eabab86b4f4ddb9da5ddbc2cba27a42a2b/echo_api-1.0.7.dev0.tar.gz" } ] }