PKxMNZ8jb+b+pynxm.py# 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) ) PKxMN;U],],pynxm-0.1.0.dist-info/LICENSE Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright {yyyy} {name of copyright owner} 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. PK!HMuSapynxm-0.1.0.dist-info/WHEEL HM K-*ϳR03rOK-J,/RH,szd&Y)r$[)T&UD"PK!Hpu pynxm-0.1.0.dist-info/METADATAV]SF}_NA2!Ou -0%@㤙>kZ"*as%ٖfLdUP_伶f(WJU4Ub#8H_bJP@ȥSuMNάaN'7xo+JjU<By|0l!.uFCW_I7gh*U4Ä*ˡQ:'tjX᷂%_ϜON dBiU#B0KT&`rysM DtZPiQeхAֺ ?7:-g ˥Ɖ*%U-hz-/uP *l1_t].ihpȄe|A ~ jzH`jZ{<HܼZ囻4Si9'ŕ5~.G:҅I|1]l+Зh(cc>4[2.I1Aeq6OJ< k{_Yw"TLlD!BUIfYIYä!f +>ܨ$pncO15 @N+QvaHDQ;?yϫ~U{>/$k;z?b>.l7