py-trackmania.io

An Asyncio Friendly Trackmania API Wrapper for Python!

Important - Trackmania.io API for my own project?

Important - 20/10/22

Project is now on hold for an indefinite amount of time as I begin university. I do not know if I will be returning to this and continuing it. Feel free to fork it and work on the project yourself if you need to. As always, you can contact me on discord at NottCurious#4351 for any questions.

See below on how to set your user agent

Your User-Agent Must Have:

1. Your Discord Username
2. Your Project Name

Example: NottCurious#4351 | TMIndiaBot

" | via py-tmio" is automatically appended to your user agent

How to set user agent.

from trackmania import Client

Client.USER_AGENT = "NottCurious#4351 | TMIndiaBot"

How to set Redis Server Settings

from trackmania import Client

Client.REDIS_HOST = "127.0.0.1" # 127.0.0.1 is default
Client.REDIS_PORT = 6379 # 6379 is default
Client.REDIS_DB = 0 # 0 is default
Client.REDIS_PASSWORD = "yadayadayada" # Defaults to None. Don't need to change this if your redis server does not have a password.

Support Server

You can report bug fixes, issues, feature request or ask for help at the discord server! (Click the Badge!)

Docs

Docs can be found on readthedocs.org.

Installation

Note: Must have Python 3.10 or higher.

python3 -m pip install py-tmio # Linux

python -m pip install py-tmio # Windows

Caching

Caching is done using a redis server. The client defaults to 127.0.0.1:6379.

Caching is not required but is highly recommended.

Pull Requests and Issues

If you have any suggestions, bugs, fixes or enhancements, please open a Pull Request or Issue

Discord

Contact me on Discord if you have any questions, NottCurious#4351

Or join the support server here!

License

MIT License