{ "info": { "author": "Martin B\u00fchrer, Felix Eichenberger", "author_email": "info@gyrotools.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "# gtagora-connector [![Build Status](https://travis-ci.org/gyrofx/gtagora-connector-py.svg?branch=master)](https://travis-ci.org/gyrofx/gtagora-connector-py)\n\ngtagora-connector is a python library to access GyroTools' Agora system.\n\n## Installation\n\nUse the package manager [pip](https://pip.pypa.io/en/stable/) to install gtagora-connector.\n\n```bash\npip install gtagora-connector\n```\n\nCurrently gtagora-connector supports python 3.6 and 3.7.\n\n## Basic usage\n\n```python\nfrom gtagora import Agora\nfrom gtagora.models.dataset import DatasetType\n\nagora = Agora.create('https://your.agora.domain.com', user='test', password='test')\n\nroot_folder = agora.get_folders()\nsubfolders = root_folder.get_folders() \nfor s in subfolders:\n print(f' - {s.name}')\n\nnew_folder = root_folder.get_or_create_folder('New Folder')\n\nexam = agora.get_exam_list(filters={'name': 'Wrist'})[0]\nfor s in exam.get_series():\n print(f'Series: {s.name}')\n\n for dataset in s.get_datasets(filters={'type': DatasetType.PHILIPS_RAW}):\n for datafile in dataset.get_datafiles():\n print(f'{datafile.original_filename}')\n\nagora.import_data('/path/to/directroy', new_folder)\n```\n\n## Exmaples\n\n### Create an Agora instanace\n\n\n```python\nfrom gtagora import Agora\n\nagora = Agora.create('https://your.agora.domain.com', user='test', password='test')\n```\n\nBecause it's not recommended to ever write down your password in plain text the API is a better alternative. Actiavte the API Key in your Agora profile. The API key is just a random UUID and it can withdrawn or recreated easily.\n\n```python\nfrom gtagora import Agora\n\nagora = Agora.create('https://your.agora.domain.com', api_key='')\n```\n\n### Working with folders\n\nGet the root folder of the current user:\n\n```python\nroot_folder = agora.get_root_folder()\nprint(f\"Root folder ID: {root_folder.id}\")\n```\n\nGet a folder by its ID\n\n```python\nfolder = agora.get_folder(45)\nprint(f\"Folder with ID {folder.name}\")\n```\n\nGet sub folders\n\n```python\nsubfolders = folder.get_folders()\nfor f in subfolders:\n print(f\" - {f.name}\")\n```\n\nCreate a new folder in the root folder (the new folder object is returned)\n\n```python\nnew_folder = root_folder.create_folder('TestFolder')\nprint(f\"New folder ID: {new_folder.id}\")\n```\n\nDelete a folder. Delete a folder is recursive. It deletes all items. The delete operation does not follow links.\n\n```python\nfolder.delete()\n```\n\n\nGet all items of a folder. An item could be a exam, series or a dataset\n\n```python\nitems = folder.get_items()\nfor item in items:\n print(f\" - {item}\")\n```\n\nGet all exams of a folder. Use the recursive parameter to get all exams \n\n```python\nexams = folder.get_exams(recursive=False)\nfor exam in exams:\n print(f\" - {exam}\")\n```\n\n### Working with Agora objects\n\nGet the list of exams\n\n```python\nexams = agora.get_exam_list()\n```\n\nGet an exam by ID\n\n```python\nexam = agora.get_exam(12)\n```\n\nLink the first Exam to the a folder\n\n```python\nexam_item = exam.link_to_folder(folder.id)\n```\n\nDelete the link of an exam (doesn't delete the Exam itself)\n\n```python\nexam_item.delete()\n```\n\n### Download data\n\nDownload all data from a folder \n\n```python\nfrom pathlib import Path\n\ntarget = Path(\"c:/temp\")\ndownloaded_files = folder.download(target, recursive=False)\nfor f in downloaded_files:\n print(str(f))\n```\n\n\n## Contributing\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\nPlease make sure to update tests as appropriate.\n\n## License\n[MIT](https://choosealicense.com/licenses/mit/)\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/gyrotools/gtagora", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "gtagora-connector", "package_url": "https://pypi.org/project/gtagora-connector/", "platform": "", "project_url": "https://pypi.org/project/gtagora-connector/", "project_urls": { "Homepage": "https://github.com/gyrotools/gtagora" }, "release_url": "https://pypi.org/project/gtagora-connector/0.0.8/", "requires_dist": [ "requests (>=2.0)" ], "requires_python": ">=3.6.0", "summary": "The Agora Connector for Python", "version": "0.0.8" }, "last_serial": 5970740, "releases": { "0.0.2": [ { "comment_text": "", "digests": { "md5": "452e803ba3c288b62865dc3f96e4db58", "sha256": "145acf22c5a5401ffdd36b11b02af27a2a7c21e7937b9d1ec59b1a40348bf827" }, "downloads": -1, "filename": "gtagora_connector-0.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "452e803ba3c288b62865dc3f96e4db58", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6.0", "size": 18757, "upload_time": "2019-02-27T15:34:51", "url": "https://files.pythonhosted.org/packages/ad/96/ccbd8269aa604d2044c08ab98f24c9ccee5aee66e63b255832be8d146af3/gtagora_connector-0.0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f8ca6e98993e64d1c14a927f117e266c", "sha256": "9abcfc4e716386310af8ba912c1542c9078b6547d20e53765f416d9884aeb2f5" }, "downloads": -1, "filename": "gtagora-connector-0.0.2.tar.gz", "has_sig": false, "md5_digest": "f8ca6e98993e64d1c14a927f117e266c", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6.0", "size": 9300, "upload_time": "2019-02-27T15:34:53", "url": "https://files.pythonhosted.org/packages/6b/73/842fec86e7eb7657c409cee2e248c30dee70fc98ff35a32016da105645aa/gtagora-connector-0.0.2.tar.gz" } ], "0.0.4": [ { "comment_text": "", "digests": { "md5": "2d2603a929eeb7b289dfc061dc20f2ed", "sha256": "bbc2d3b6f4bbc21f8dc6752043c99ebaa76127837bc6e4276c5ac1520304b2fe" }, "downloads": -1, "filename": "gtagora_connector-0.0.4-py3-none-any.whl", "has_sig": false, "md5_digest": "2d2603a929eeb7b289dfc061dc20f2ed", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6.0", "size": 22602, "upload_time": "2019-05-09T07:44:05", "url": "https://files.pythonhosted.org/packages/ec/96/56d39d83c18e4a11b29e884802614940b711405d380142858b51c4ab3750/gtagora_connector-0.0.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c8a28ba4e2243a23b1c804efe3b7a1b8", "sha256": "def70268fb12dbfd0227083396ad6187e6c92b37541597127b503f6d1b38b1c2" }, "downloads": -1, "filename": "gtagora-connector-0.0.4.tar.gz", "has_sig": false, "md5_digest": "c8a28ba4e2243a23b1c804efe3b7a1b8", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6.0", "size": 13271, "upload_time": "2019-05-09T07:44:06", "url": "https://files.pythonhosted.org/packages/9f/c8/943026855c877be1e17445d8badb788161cc8245906aa4703e2d5096c0e8/gtagora-connector-0.0.4.tar.gz" } ], "0.0.6": [ { "comment_text": "", "digests": { "md5": "bedbb057a1ba0b569a81334309097602", "sha256": "97780f28046e873d5aa00ca0c637bd9b42adafc1f3584b913d567161404bbaea" }, "downloads": -1, "filename": "gtagora_connector-0.0.6-py3-none-any.whl", "has_sig": false, "md5_digest": "bedbb057a1ba0b569a81334309097602", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6.0", "size": 24696, "upload_time": "2019-06-07T10:04:33", "url": "https://files.pythonhosted.org/packages/3a/99/fe54350911631adb0d04026482ba43f75ea10014be8291458995fa5a8151/gtagora_connector-0.0.6-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "384a4efe67f155153e6b8c82d62c4419", "sha256": "10a824aad71fae77db861c07f02ca610d0ef7af708787ac90e70acb996dd6be3" }, "downloads": -1, "filename": "gtagora-connector-0.0.6.tar.gz", "has_sig": false, "md5_digest": "384a4efe67f155153e6b8c82d62c4419", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6.0", "size": 16320, "upload_time": "2019-06-07T10:04:34", "url": "https://files.pythonhosted.org/packages/d4/43/b4338e6818b9a3cab9189fbbeaf59f0e2369ac225d6722162367d2d39814/gtagora-connector-0.0.6.tar.gz" } ], "0.0.7": [ { "comment_text": "", "digests": { "md5": "5bcf6a193c9cab0e7b982586df9bf7ed", "sha256": "c11d4488135a7ebf10ff419de676f42b63123f9b8e481493bc25ae6fbcf1e198" }, "downloads": -1, "filename": "gtagora_connector-0.0.7-py3-none-any.whl", "has_sig": false, "md5_digest": "5bcf6a193c9cab0e7b982586df9bf7ed", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6.0", "size": 24769, "upload_time": "2019-07-16T07:32:59", "url": "https://files.pythonhosted.org/packages/46/4c/3102c03ffc1d702b5f85b411893cd9d91dc83783c2ebfbca57671cec2b36/gtagora_connector-0.0.7-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c7f842bd6c103dc267580c547200ba34", "sha256": "2b3d44b33de4b9c08dc819609c86d98551f2cfb5963057bfa59fca3930ba693d" }, "downloads": -1, "filename": "gtagora-connector-0.0.7.tar.gz", "has_sig": false, "md5_digest": "c7f842bd6c103dc267580c547200ba34", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6.0", "size": 16287, "upload_time": "2019-07-16T07:33:00", "url": "https://files.pythonhosted.org/packages/b9/55/a2e5e6dc971d7d9f3706b5c8fc14785ad9f381eb6b608c1fa169f329a2ea/gtagora-connector-0.0.7.tar.gz" } ], "0.0.8": [ { "comment_text": "", "digests": { "md5": "5b672793dd90b7fb6d37d38dbcc94de4", "sha256": "170d6b5ece40195ffe6d64c655406755776014fba23c456c196bbdf2863b5af6" }, "downloads": -1, "filename": "gtagora_connector-0.0.8-py3-none-any.whl", "has_sig": false, "md5_digest": "5b672793dd90b7fb6d37d38dbcc94de4", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6.0", "size": 25064, "upload_time": "2019-10-14T10:11:17", "url": "https://files.pythonhosted.org/packages/e3/c5/fb8d434375e44855ab485a09182df706cf32f555273294c328822e9a3c09/gtagora_connector-0.0.8-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "61d81940d14a6f357d9989d2dd76ab60", "sha256": "9c231a634d4e9fa56207332df18aa2737d4717ac982f1f8dbb269527ef243cec" }, "downloads": -1, "filename": "gtagora-connector-0.0.8.tar.gz", "has_sig": false, "md5_digest": "61d81940d14a6f357d9989d2dd76ab60", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6.0", "size": 16504, "upload_time": "2019-10-14T10:11:19", "url": "https://files.pythonhosted.org/packages/f3/cb/a09189ac89e5e6bab44e0c8420d5ae04b6dfbed7ed095c22f21b042f23e2/gtagora-connector-0.0.8.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "5b672793dd90b7fb6d37d38dbcc94de4", "sha256": "170d6b5ece40195ffe6d64c655406755776014fba23c456c196bbdf2863b5af6" }, "downloads": -1, "filename": "gtagora_connector-0.0.8-py3-none-any.whl", "has_sig": false, "md5_digest": "5b672793dd90b7fb6d37d38dbcc94de4", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6.0", "size": 25064, "upload_time": "2019-10-14T10:11:17", "url": "https://files.pythonhosted.org/packages/e3/c5/fb8d434375e44855ab485a09182df706cf32f555273294c328822e9a3c09/gtagora_connector-0.0.8-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "61d81940d14a6f357d9989d2dd76ab60", "sha256": "9c231a634d4e9fa56207332df18aa2737d4717ac982f1f8dbb269527ef243cec" }, "downloads": -1, "filename": "gtagora-connector-0.0.8.tar.gz", "has_sig": false, "md5_digest": "61d81940d14a6f357d9989d2dd76ab60", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6.0", "size": 16504, "upload_time": "2019-10-14T10:11:19", "url": "https://files.pythonhosted.org/packages/f3/cb/a09189ac89e5e6bab44e0c8420d5ae04b6dfbed7ed095c22f21b042f23e2/gtagora-connector-0.0.8.tar.gz" } ] }