Metadata-Version: 2.1
Name: ritc
Version: 1.0.0
Summary: A Python library for interactions with Rotman Interactive Trader Market Simulator Client Application via REST exchange API
Home-page: https://github.com/AussieSeaweed/ritc
Author: Juho Kim
Author-email: juho-kim@outlook.com
License: MIT
Project-URL: Documentation, https://ritc.readthedocs.io/en/latest/
Project-URL: Source, https://github.com/AussieSeaweed/ritc
Project-URL: Tracker, https://github.com/AussieSeaweed/ritc/issues
Keywords: rotman,rit,bmo,uoft
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Intended Audience :: Information Technology
Classifier: Topic :: Education
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: requests (~=2.28.2)

ritc
====

A Python library for interactions with Rotman Interactive Trader Market
Simulator Client Application via REST exchange API

The official REST API for Rotman Interactive Trader can be found in their
`API documentation`_.

.. _API documentation: https://rit.306w.ca/RIT-REST-API/

Features
--------

This library aims to be as lean and efficient as possible while automatically
handling all of the repetitive and frustrating parts of interacting with the
Rotman Interactive Trader. Some of the features include:

- Automatic handling of ``rate limit exceeded.`` error responses.
- Programmatic interface for all available RIT REST API.
- Strict ``mypy`` type-checking compatibility.
- Futureproof design compatible with every RIT REST API versions...

Installation
------------

This library is available on PyPI_.

.. _PyPI: https://pypi.org/project/ritc/

You can install it by executing the following command:

.. code-block:: sh

   pip install ritc

Documentation
-------------

You can read the latest_ and stable_ documentation online. Or, you can also
generate the documentation for offline viewing with Sphinx.

.. _latest: https://ritc.readthedocs.io/en/latest/
.. _stable: https://ritc.readthedocs.io/en/stable/
