{ "info": { "author": "Anton Kaiser", "author_email": "kaiser@kaiser.ovh", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "\n\n# RightSignature API written in Python\n## by Anton Kaiser\n\n#### pip install RightSignature\n\nGet the API-Key from [here](https://rightsignature.com/oauth_clients) called \"Secure Token\"\n\n\n\nInitialize\n```\nfrom rightsignature import *\nAPI_KEY = \"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\"\nRightSignature = RightSignature.CRightSignature(API_KEY)\nif not RightSignature.isLoggedIn():\n\tprint(\"Wrong API Key!\")\n\texit(0)\n```\n\nGet the Document Array\n```\nfor document in RightSignature.getDocuments(): // get the Array\n\tdocument = RightSignature.getDocument(document.getGuid()) // get the full Object\n```\n\ndownload a signed PDF\n```\nRightSignature.downloadSignedPDF(document,\"./\" + document.getGuid() + '.pdf')\n```\n\nClasses/Objects\n```\nCRightSignature:\ngetDocuments(date=\"alltime\", debug=False) - Returns a CDocument Array - the CDocument is not full filled!\n\tdate: 'today', 'thisweek', 'thismonth', 'alltime'\n\t\t\tor a date in the format 'yyyy-mm-dd'\n\tdebug: Print debug logs\n\thint: the script loads all pages!\ngetDocumentsRange(dateStart=\"2019-01-25\", dateEnd=\"2019-05-25\", debug=False) - Returns a CDocument Array - the CDocument is not full filled!\n\tdateStart/dateEnd: in the format 'yyyy-mm-dd'\n\tdebug: Print debug logs\n\thint: the script loads all pages!\ngetDocument(documentGUID) - Returns a full CDocument\ndownloadSignedPDF(CDocument, location, debug=False) - Returns a void\n\tdebug: prints a message when a download failed\n\thint: when a download fails, the script will redownload the file\nisLoggedIn() - Returns a boolean\n```\n\n```\nCDocument:\ngetAuditTrails() - Returns a CAudiot Array\ngetCallbackLocation() - Returns a String\ngetCompletedAt() - Returns a String\ngetContentType() - Returns a String\ngetCreatedAt() - Returns a String\ngetExpiresOn() - Returns a String\ngetFormFields() - Returns a CField Array\ngetGuid() - Returns a String\nisTrashed() = Returns a boolean\ngetLargeUrl() - Returns a String\ngetLastActivityAt() - Returns a String\ngetMergeState() - Returns a String\ngetMessage() - Returns a String\ngetOriginalFilename() - Returns a String\ngetOriginalUrl() - Returns a String\ngetPages() - Returns a CPage Array\ngetPdfUrl() - Returns a String\ngetProcessingState() - Returns a String\ngetRecipients() - Returns a CRecipient Array\ngetSignedPdfChecksum() - Returns a String\ngetSignedPdfUrl() - Returns a String\ngetSize() - Returns a String\ngetState() - Returns a String\ngetSubject() - Returns a String\ngetTags() - Returns a String\ngetThumbnailUrl() - Returns a String\n```\n\n```\nCAudit:\ngetKeyword() - Returns a String\ngetMessage() - Returns a String\ngetTimestamp() - Returns a String\n```\n```\nCRecipient:\ngetCompletedAt() - Returns a String\ngetDocumentRoleID() - Returns a String\ngetEmail() - Returns a String\nisSender() - Returns a String\ngetMustSign() - Returns a String\ngetName() - Returns a String\ngetRoleID() - Returns a String\ngetState() - Returns a String\ngetViewedAt() - Returns a String\n```\n\n\n```\nCPage:\ngetOriginalTemplateFilename() - Returns a String\ngetOriginalTemplateGUID() - Returns a String\ngetPageNumber() - Returns a String\n```\n\n\n```\nCField:\ngetID() - Returns a String\ngetName() - Returns a String\ngetPage() - Returns a String\ngetRoleID() - Returns a String\ngetValue() - Returns a String\n```\n\nExample:\n```\nfor document in RightSignature.getDocuments():\n\tdocument = RightSignature.getDocument(document.getGuid())\n\tprint(\"\")\n\tprint(\"=====================================================\")\n\tprint(\"===========\" + document.getGuid() + \" | \" + document.getState() + \"===========\")\n\tprint(\"=====================================================\")\n\tname = document.getOriginalFilename().replace(\".pdf\",\"\").replace(\"-\",\"_\")\n\tif len(document.getFormFields()) > 0:\n\t\tprint(\"Document is ready!\")\n\t\tprint(\"Downloading...\")\n\t\tRightSignature.downloadSignedPDF(document,\"./\" + document.getGuid() + '.pdf')\n\telse:\n\t\tprint(\"Still on \" + document.getState())\n\t\tprint(\"User opened the document last time at the: \" + document.getLastActivityAt())\n\tprint(\"=====================================================\")\n\n\n```\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/kaiseranton/RightSignature", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "rightsignature", "package_url": "https://pypi.org/project/rightsignature/", "platform": "", "project_url": "https://pypi.org/project/rightsignature/", "project_urls": { "Homepage": "https://github.com/kaiseranton/RightSignature" }, "release_url": "https://pypi.org/project/rightsignature/1.2/", "requires_dist": [ "requests (>=2.21.0)", "datetime (>=4.3)" ], "requires_python": "", "summary": "RightSignature API written in python", "version": "1.2" }, "last_serial": 5251576, "releases": { "1.0": [ { "comment_text": "", "digests": { "md5": "33ddd1e072c379f0a4f3bfec47c58244", "sha256": "678b4cd4fb452526556e20a2e82b84b0a8cd8058a391b683bedadc9ec1637152" }, "downloads": -1, "filename": "rightsignature-1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "33ddd1e072c379f0a4f3bfec47c58244", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4147, "upload_time": "2019-05-09T13:22:22", "url": "https://files.pythonhosted.org/packages/8e/49/d4c3b4013d26b4c6d16417be9a69286c11dabad320d7eb4434de714af6a0/rightsignature-1.0-py3-none-any.whl" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "d6b267b325174ecf97974f91d04aed4d", "sha256": "5bd650b9e17ddeead9b3f31c813973127e8a86d372f13d8e2d6d045d38a48067" }, "downloads": -1, "filename": "rightsignature-1.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "d6b267b325174ecf97974f91d04aed4d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4934, "upload_time": "2019-05-09T13:42:24", "url": "https://files.pythonhosted.org/packages/7d/58/09fcb656a63612ad09a5f1f0b7ad55bd12a721064290b4afdb2b9b8071fe/rightsignature-1.0.1-py3-none-any.whl" } ], "1.1": [ { "comment_text": "", "digests": { "md5": "1c7de0db8a033037592d0c3cd27fd9de", "sha256": "8252dcde11b6cb3a58e43737c245246799f249d4d69422c85a6f35635ad13bfd" }, "downloads": -1, "filename": "rightsignature-1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "1c7de0db8a033037592d0c3cd27fd9de", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5333, "upload_time": "2019-05-10T09:20:28", "url": "https://files.pythonhosted.org/packages/34/9c/f9fa55f2007a0458299088588a1bae22559f6b6d170403757ad8f5dcf65f/rightsignature-1.1-py3-none-any.whl" } ], "1.2": [ { "comment_text": "", "digests": { "md5": "cbb183dc04bf89d037de1636f60743d7", "sha256": "fb099e1800736bd52adb1ea40f5e52e20814ac67e012b1ab857364d804a74321" }, "downloads": -1, "filename": "rightsignature-1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "cbb183dc04bf89d037de1636f60743d7", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5702, "upload_time": "2019-05-10T10:27:06", "url": "https://files.pythonhosted.org/packages/5d/25/5fc24df21770b4a9014758d306e1676aff29ad5e4d68fdd4e8aa703a7dd1/rightsignature-1.2-py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "cbb183dc04bf89d037de1636f60743d7", "sha256": "fb099e1800736bd52adb1ea40f5e52e20814ac67e012b1ab857364d804a74321" }, "downloads": -1, "filename": "rightsignature-1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "cbb183dc04bf89d037de1636f60743d7", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5702, "upload_time": "2019-05-10T10:27:06", "url": "https://files.pythonhosted.org/packages/5d/25/5fc24df21770b4a9014758d306e1676aff29ad5e4d68fdd4e8aa703a7dd1/rightsignature-1.2-py3-none-any.whl" } ] }