Metadata-Version: 2.1
Name: async-truckersmp
Version: 0.1
Summary: An asynchronous Python API wrapper for TruckersMP.
Home-page: https://github.com/SamNuttall/Async-TruckersMP
Author: Sam Nuttall
Author-email: nuttall.sam@gmail.com
License: MIT
Keywords: truckersmp
Platform: UNKNOWN
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
License-File: LICENSE

<h1>Async-TruckersMP</h1>
<p>An asynchronous Python API wrapper for <a href="https://truckersmp.com/">TruckersMP</a></p>

<p>This library is a work in progress. It has not been thoroughly tested and therefore, may not work as intended.</p>


<h2>Features</h2>
<ul>
<li><b>Rate limiting</b> - Pre-emptive rate limiting so you'll never hit a 429.</li>
<li><b>Caching</b> - Automatic caching of responses so you don't have to.</li>
<li><b>Configurable</b> - Several configuration options on initialisation.</li>
<li><b>Documented</b> - Full docs with examples included for reference.</li>
<li><b>Data models</b> - API responses are parsed into objects (Python classes).</li>
</ul>


<h2>Usage</h2>
<h3>Install</h3>
<p>Install via pip:</p>
```py
from truckersmp import TruckersMP
```


<h3>Quickstart</h3>
<p>Install via pip:</p>

<h2>License</h2>
<p>Released under the <a href="https://www.gnu.org/licenses/gpl-3.0.en.html">MIT License</a>.</p>


