This repository has been archived by the owner on Jan 11, 2023. It is now read-only.
forked from dh-nunes/pynxm
-
Notifications
You must be signed in to change notification settings - Fork 0
/
pynxm.py
342 lines (288 loc) · 10.8 KB
/
pynxm.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
# Copyright 2019 Daniel Nunes
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""A python wrapper for the Nexus API."""
__version__ = "0.1.0"
import json
import platform
import uuid
import webbrowser
import requests
from websocket import create_connection
USER_AGENT = "pynxm/{} ({}; {}) {}/{}".format(
__version__,
platform.platform(),
platform.architecture()[0],
platform.python_implementation(),
platform.python_version(),
)
BASE_URL = "https://api.nexusmods.com/v1/"
class LimitReachedError(Exception):
"""
Exception raised when the request rate limit has been reached.
"""
pass
class RequestError(Exception):
"""
Exception raised when a request returns an error code.
"""
pass
class Nexus(object):
"""
The class used for connecting to the Nexus API.
Requires an API key from your Nexus account.
"""
def __init__(self, api_key):
self.session = requests.Session()
self.session.headers.update(
{
"user-agent": USER_AGENT,
"apikey": api_key,
"content-type": "application/json",
}
)
@classmethod
def sso(cls, app_slug, sso_token, sso_id=None):
"""
Application login via Single Sign-On (SSO).
:param app_slug: A string with the application slug.
:param sso_token: A string with the connection token.
:param sso_id: An optional string with an id used in previous connections.
:return: A 'Nexus' instance, ready to be used.
"""
ws = create_connection("wss://sso.nexusmods.com")
if sso_id is None:
sso_id = str(uuid.uuid4())
ws.send(json.dumps({"id": sso_id, "token": sso_token}))
webbrowser.open(
"https://www.nexusmods.com/"
"sso?id={}&application={}".format(sso_id, app_slug)
)
api_key = ws.recv()
return cls(api_key)
def _make_request(self, operation, endpoint, payload=None, data=None, headers=None):
if payload is None:
payload = {}
if data is None:
data = {}
if headers is None:
headers = {}
response = self.session.request(
operation.upper(),
BASE_URL + endpoint,
params=payload,
data=data,
headers=headers,
timeout=30,
)
status_code = response.status_code
if status_code not in (200, 201):
if status_code == 429:
raise LimitReachedError(
"You have reached your request limit. "
"Please wait one hour before trying again."
)
else:
try:
msg = response.json()["message"]
except KeyError:
msg = response.json()["error"]
raise RequestError("Status Code {} - {}".format(status_code, msg))
return response.json()
def colour_schemes_list(self):
"""
Returns a list of all colour schemes, including the
primary, secondary and 'darker' colours.
"""
return self._make_request("get", "colourschemes.json")
def user_details(self):
"""
Returns the user's details.
"""
return self._make_request("get", "users/validate.json")
def user_tracked_list(self):
"""
Returns a list of all the mods being tracked by the current user.
"""
return self._make_request("get", "user/tracked_mods.json")
def user_tracked_add(self, game, mod_id):
"""
Tracks this mod with the current user.
:param game: A string with Nexus' game domain.
:param mod_id: A string the mod id.
"""
self._make_request(
"post",
"user/tracked_mods.json",
payload={"domain_name": game},
data={"mod_id": mod_id},
headers={"content-type": "application/x-www-form-urlencoded"},
)
def user_tracked_delete(self, game, mod_id):
"""
Stop tracking this mod with the current user.
:param game: A string with Nexus' game domain.
:param mod_id: A string the mod id.
"""
self._make_request(
"delete",
"user/tracked_mods.json",
payload={"domain_name": game},
data={"mod_id": mod_id},
headers={"content-type": "application/x-www-form-urlencoded"},
)
def user_endorsements_list(self):
"""
Returns a list of all endorsements for the current user.
"""
return self._make_request("get", "user/endorsements.json")
def game_details(self, game):
"""
Returns specified game, along with download count, file count and categories.
:param game: A string with Nexus' game domain.
"""
return self._make_request("get", "games/{}.json".format(game))
def game_list(self, include_unapproved=False):
"""
Returns a list of all games.
:param include_unapproved: A boolean on whether to include unapproved games.
"""
return self._make_request(
"get", "games.json", payload={"include_unapproved": include_unapproved}
)
def game_updated_list(self, game, period):
"""
Returns a list of mods that have been updated in a given period,
with timestamps of their last update.
:param game: A string with Nexus' game domain.
:param period: Acceptable values: '1d' (1 day), '1w' (1 week) or '1m' (1 month).
"""
if period not in ("1d", "1w", "1m"):
raise ValueError("Allowed values for 'period' argument: '1d', '1w', '1m'.")
return self._make_request(
"get", "games/{}/mods/updated.json".format(game), payload={"period": period}
)
def game_latest_added_list(self, game):
"""
Retrieve 10 latest added mods for a specified game.
:param game: A string with Nexus' game domain.
"""
return self._make_request("get", "games/{}/mods/latest_added.json".format(game))
def game_latest_updated_list(self, game):
"""
Retrieve 10 latest updated mods for a specified game.
:param game: A string with Nexus' game domain.
"""
return self._make_request(
"get", "games/{}/mods/latest_updated.json".format(game)
)
def game_trending_list(self, game):
"""
Retrieve 10 trending mods for a specified game.
:param game: A string with Nexus' game domain.
"""
return self._make_request("get", "games/{}/mods/trending.json".format(game))
def mod_details(self, game, mod_id):
"""
Retrieve specified mod details, from a specified game.
:param game: A string with Nexus' game domain.
:param mod_id: A string the mod id.
"""
return self._make_request("get", "games/{}/mods/{}.json".format(game, mod_id))
def mod_search(self, game, md5_hash):
"""
Searches for a mod given its md5 hash.
:param game: A string with Nexus' game domain.
:param md5_hash: Mod md5 hash.
"""
return self._make_request(
"get", "games/{}/mods/md5_search/{}.json".format(game, md5_hash)
)
def mod_endorse(self, game, mod_id):
"""
Endorse a mod.
:param game: A string with Nexus' game domain.
:param mod_id: A string the mod id.
"""
return self._make_request(
"post", "games/{}/mods/{}/endorse.json".format(game, mod_id)
)
def mod_abstain(self, game, mod_id):
"""
Abstain from endorsing a mod.
:param game: A string with Nexus' game domain.
:param mod_id: A string the mod id.
"""
return self._make_request(
"post", "games/{}/mods/{}/abstain.json".format(game, mod_id)
)
def mod_file_list(self, game, mod_id, categories=None):
"""
Lists all files for a specific mod.
:param game: A string with Nexus' game domain.
:param mod_id: A string the mod id.
:param categories: Filter file category.
Accepts either a list of categories or a comma-separated
string of categories.
Possible categories: 'main', 'update', 'optional',
'old_version' and 'miscellaneous'.
"""
if isinstance(categories, (tuple, list)):
payload = {"category": ",".join(categories)}
elif isinstance(categories, str):
payload = {"category": categories}
else:
payload = None
return self._make_request(
"get", "games/{}/mods/{}/files.json".format(game, mod_id), payload=payload
)
def mod_file_details(self, game, mod_id, file_id):
"""
View a specified mod file, using a specified game and mod.
:param game: A string with Nexus' game domain.
:param mod_id: A string the mod id.
:param file_id: A string with the file id.
"""
return self._make_request(
"get", "games/{}/mods/{}/files/{}.json".format(game, mod_id, file_id)
)
def mod_file_download_link(self, game, mod_id, file_id, nxm_key=None, expires=None):
"""
Generate download link for mod file.
Note: For non-premium users, see the Nexus API docs
on how to obtain the key/expires strings.
:param game: A string with Nexus' game domain.
:param mod_id: A string the mod id.
:param file_id: A string with the file id.
:param nxm_key: A string with the nxm file key.
:param expires: A string with the nxm expires.
"""
if None in (nxm_key, expires):
payload = None
else:
payload = {"key": nxm_key, "expires": expires}
return self._make_request(
"get",
"games/{}/mods/{}/files/{}/"
"download_link.json".format(game, mod_id, file_id),
payload=payload,
)
def mod_changelog_list(self, game, mod_id):
"""
Returns list of changelogs for mod.
:param game: A string with Nexus' game domain.
:param mod_id: A string the mod id.
"""
return self._make_request(
"get", "games/{}/mods/{}/changelogs.json".format(game, mod_id)
)