Welcome to modio’s documentation!¶
mod.io is a python object-oriented wrapper libary for the mod.io API that supports both sync and async applications. Most blocking methods have both a synchronous version and async method for use within async applications.
Basic Usage¶
import modio
client = modio.Client(
api_key="your api key here",
access_token="your o auth 2 token here"
)
game = client.get_game(345)
#gets the game with id 345
print(game.name)
#prints the name of the game
mod = game.get_mod(231)
#gets the mod for that game with id 231
Getting an OAuth 2 Access Token¶
To perform writes, you will need to authenticate your users via OAuth 2. To make this easy this library provides you with two functions to use in order to obtain your Access Token. You will need an API Key and an email adress to which you have access in order for this to work. Once you have both, follow the example below, you can either run this in a REPL or as a Python script. Don’t forget to edit the script to add your own api key and email adress.
Example¶
import modio
client = modio.Client(api_key="your api key here")
#request a security code be sent at this email adress
client.email_request("necro@mordor.com")
#check your email for the security code
code = input("Code: ")
oauth2 = client.email_exchange(code)
#your oauth2 token is now stored in the variable
#to save into a file simply
with open("oauth2.txt", "w") as file:
file.write(oauth2)
#and now the token is stored in oauth2.txt
See more examples here .
Installation¶
pip install mod.io
Uninstalling¶
pip uninstall mod.io