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/
Raw data
{
"_id": null,
"home_page": "https://github.com/AussieSeaweed/ritc",
"name": "ritc",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "rotman,rit,bmo,uoft",
"author": "Juho Kim",
"author_email": "juho-kim@outlook.com",
"download_url": "https://files.pythonhosted.org/packages/43/68/b0c701da2df5c7981f701dc1874ada2a7e92b94369f0ec39187bb5b7aef9/ritc-1.0.0.tar.gz",
"platform": null,
"description": "ritc\n====\n\nA Python library for interactions with Rotman Interactive Trader Market\nSimulator Client Application via REST exchange API\n\nThe official REST API for Rotman Interactive Trader can be found in their\n`API documentation`_.\n\n.. _API documentation: https://rit.306w.ca/RIT-REST-API/\n\nFeatures\n--------\n\nThis library aims to be as lean and efficient as possible while automatically\nhandling all of the repetitive and frustrating parts of interacting with the\nRotman Interactive Trader. Some of the features include:\n\n- Automatic handling of ``rate limit exceeded.`` error responses.\n- Programmatic interface for all available RIT REST API.\n- Strict ``mypy`` type-checking compatibility.\n- Futureproof design compatible with every RIT REST API versions...\n\nInstallation\n------------\n\nThis library is available on PyPI_.\n\n.. _PyPI: https://pypi.org/project/ritc/\n\nYou can install it by executing the following command:\n\n.. code-block:: sh\n\n pip install ritc\n\nDocumentation\n-------------\n\nYou can read the latest_ and stable_ documentation online. Or, you can also\ngenerate the documentation for offline viewing with Sphinx.\n\n.. _latest: https://ritc.readthedocs.io/en/latest/\n.. _stable: https://ritc.readthedocs.io/en/stable/\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python library for interactions with Rotman Interactive Trader Market Simulator Client Application via REST exchange API",
"version": "1.0.0",
"project_urls": {
"Documentation": "https://ritc.readthedocs.io/en/latest/",
"Homepage": "https://github.com/AussieSeaweed/ritc",
"Source": "https://github.com/AussieSeaweed/ritc",
"Tracker": "https://github.com/AussieSeaweed/ritc/issues"
},
"split_keywords": [
"rotman",
"rit",
"bmo",
"uoft"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2884d3a802abb6510d44ae431f441a3f4ac1650e28d65247d531513b75a073d0",
"md5": "b8c0b9a06c2af98bb915142f871d67d3",
"sha256": "5524181acd00abf5a017a54b29884cef9dfed10e57540b0aaf3a69e869acd392"
},
"downloads": -1,
"filename": "ritc-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b8c0b9a06c2af98bb915142f871d67d3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 9970,
"upload_time": "2023-05-15T18:16:03",
"upload_time_iso_8601": "2023-05-15T18:16:03.035475Z",
"url": "https://files.pythonhosted.org/packages/28/84/d3a802abb6510d44ae431f441a3f4ac1650e28d65247d531513b75a073d0/ritc-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4368b0c701da2df5c7981f701dc1874ada2a7e92b94369f0ec39187bb5b7aef9",
"md5": "55614cb59b45c31e4b26cb590eb1673d",
"sha256": "b2f09a1dd32a29bb7d0e2266596e0ae1fb96095b7bf5a5d07359cc08db63013a"
},
"downloads": -1,
"filename": "ritc-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "55614cb59b45c31e4b26cb590eb1673d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 10842,
"upload_time": "2023-05-15T18:16:05",
"upload_time_iso_8601": "2023-05-15T18:16:05.279823Z",
"url": "https://files.pythonhosted.org/packages/43/68/b0c701da2df5c7981f701dc1874ada2a7e92b94369f0ec39187bb5b7aef9/ritc-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-15 18:16:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "AussieSeaweed",
"github_project": "ritc",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "build",
"specs": [
[
"~=",
"0.10.0"
]
]
},
{
"name": "flake8",
"specs": [
[
"~=",
"6.0.0"
]
]
},
{
"name": "mypy",
"specs": [
[
"~=",
"1.3.0"
]
]
},
{
"name": "requests",
"specs": [
[
"~=",
"2.30.0"
]
]
},
{
"name": "Sphinx",
"specs": [
[
"~=",
"6.2.1"
]
]
},
{
"name": "sphinx-rtd-theme",
"specs": [
[
"~=",
"1.2.0"
]
]
},
{
"name": "twine",
"specs": [
[
"~=",
"4.0.2"
]
]
},
{
"name": "types-requests",
"specs": [
[
"~=",
"2.30.0.0"
]
]
}
],
"lcname": "ritc"
}
JSON
