gtagora-connector Documentation
================================

**gtagora-connector** is the official Python library for interacting with
`GyroTools' Agora <https://www.gyrotools.com/gt/index.php/products/agora>`_
— a web-based platform for managing and processing MRI data.

With the connector you can:

* Browse and organise projects, folders, exams, series and datasets
* Upload and download data — including advanced resumable uploads
* Trigger and monitor server-side processing tasks
* Tag and search objects

.. code-block:: python

   from gtagora import Agora

   agora = Agora.create('https://agora.mycompany.com', api_key='<YOUR_API_KEY>')
   root  = agora.get_myagora().get_root_folder()
   for folder in root.get_folders():
       print(folder.name)

----

.. toctree::
   :maxdepth: 1
   :caption: Getting Started

   src/installation
   src/quickstart

.. toctree::
   :maxdepth: 2
   :caption: Examples

   src/examples/index

.. toctree::
   :maxdepth: 2
   :caption: API Reference

   src/api/index

.. toctree::
   :maxdepth: 1
   :caption: About

   src/changelog

Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`