================================
pyror |version| documentation
================================

|ghactions| |black|

A client for Research Organization Registry's (ROR) API

`ROR <https://ror.org/>`__

`ROR API docs <https://ror.readme.io/docs/rest-api>`__

Getting help
============

Having trouble? Or want to know how to get started?

* Looking for specific information? Try the :ref:`genindex`
* Report bugs with pyror in our `issue tracker`_.

.. _issue tracker: https://github.com/sckott/pyror/issues


Installation
============

.. toctree::
   :caption: Installation
   :hidden:

   intro/install

:doc:`intro/install`
    How to install pyror.


Modules
=======

.. toctree::
   :caption: Methods
   :hidden:

   pyror
   ror

:doc:`pyror`
    The pyror module

:doc:`ror`
    The ror command line script

All the rest
============

.. toctree::
   :caption: All the rest
   :hidden:

   changelog_link
   contributing
   conduct
   license

:doc:`changelog_link`
    See what has changed in recent pyror versions.

:doc:`contributing`
    Learn how to contribute to the pyror project.

:doc:`conduct`
    Expected behavior in this community. By participating in this project you agree to abide by its terms.

:doc:`license`
    The pyror license.

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

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

.. |ghactions| image:: https://github.com/sckott/pyror/workflows/Python/badge.svg
   :target: https://github.com/sckott/pyror/actions?query=workflow%3APython

.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
   :target: https://github.com/psf/black