From 97fff4e56552835ebbd3a9e8118a67a21c497467 Mon Sep 17 00:00:00 2001 From: Daniel Nunes Date: Wed, 13 Feb 2019 02:03:56 +0000 Subject: [PATCH] Initial release --- .bumpversion.cfg | 10 ++ .gitattributes | 12 ++ .gitignore | 70 ++++++++++ .readthedocs.yml | 7 + .travis.yml | 27 ++++ LICENSE | 201 ++++++++++++++++++++++++++++ README.rst | 99 ++++++++++++++ appveyor.yml | 17 +++ docs/Makefile | 19 +++ docs/conf.py | 192 ++++++++++++++++++++++++++ docs/index.rst | 7 + docs/make.bat | 35 +++++ pynxm.py | 342 +++++++++++++++++++++++++++++++++++++++++++++++ pyproject.toml | 27 ++++ test_pynxm.py | 219 ++++++++++++++++++++++++++++++ tox.ini | 40 ++++++ 16 files changed, 1324 insertions(+) create mode 100644 .bumpversion.cfg create mode 100644 .gitattributes create mode 100644 .gitignore create mode 100644 .readthedocs.yml create mode 100644 .travis.yml create mode 100644 LICENSE create mode 100644 README.rst create mode 100644 appveyor.yml create mode 100644 docs/Makefile create mode 100644 docs/conf.py create mode 100644 docs/index.rst create mode 100644 docs/make.bat create mode 100644 pynxm.py create mode 100644 pyproject.toml create mode 100644 test_pynxm.py create mode 100644 tox.ini diff --git a/.bumpversion.cfg b/.bumpversion.cfg new file mode 100644 index 0000000..8dce40e --- /dev/null +++ b/.bumpversion.cfg @@ -0,0 +1,10 @@ +[bumpversion] +current_version = 0.1.0 +commit = True +tag = True +tag_name = {new_version} + +[bumpversion:file:pynxm.py] + +[bumpversion:file:docs/conf.py] + diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..bc87f59 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,12 @@ +* text=auto eol=lf + +*.bat text eol=crlf +*.md text +*.xsd text +*.sh text +*.txt text +*.ui text +*.py text + +*.png binary +*.jpg binary diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f928444 --- /dev/null +++ b/.gitignore @@ -0,0 +1,70 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so +*.o +*.a + +# Distribution / packaging +.Python +env/ +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +*.egg-info/ +.installed.cfg +*.egg + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*,cover +.hypothesis/ +.pytest_cache + +# Translations +*.mo +*.pot + +# Django stuff: +*.log + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +#Ipython Notebook +.ipynb_checkpoints + +#PyCharm +.idea/ + +#Vagrant +.vagrant/ diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..f9ff1db --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,7 @@ +version: 2 + +python: + version: 3.7 + install: + - method: pip + path: . \ No newline at end of file diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..e0dd6ca --- /dev/null +++ b/.travis.yml @@ -0,0 +1,27 @@ +dist: xenial + +language: python + +python: + - 3.6 + - 3.7 + - 3.7-dev + +jobs: + include: + - stage: deploy + install: pip install flit + script: skip + if: tag IS present + deploy: + provider: script + script: flit publish + on: + tags: true + +install: + - pip install -U pip + - pip install tox + +script: + - tox -e check,py diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8dada3e --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + 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. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..636aa09 --- /dev/null +++ b/README.rst @@ -0,0 +1,99 @@ +===== +pynxm +===== +.. image:: https://img.shields.io/pypi/v/pynxm.svg?style=flat-square&label=PyPI + :target: https://pypi.org/project/pynxm/ +.. image:: https://img.shields.io/pypi/pyversions/pynxm.svg?style=flat-square&label=Python%20Versions + :target: https://pypi.org/project/pynxm/ +.. image:: https://img.shields.io/travis/GandaG/pynxm/master.svg?style=flat-square&label=Linux%20Build + :target: https://travis-ci.org/GandaG/pynxm +.. image:: https://img.shields.io/appveyor/ci/GandaG/pynxm/master.svg?style=flat-square&label=Windows%20Build + :target: https://ci.appveyor.com/project/GandaG/pynxm/branch/master + +*A python wrapper for the Nexus API.* + +Features: + +- Retrieve information regarding colour-specific themes for games; +- Access resources specific to a user: + - Get user details; + - Get user's endorsements; + - Get, add and delete user's tracked mods. +- Retrieve game information; +- Access mod information: + - Get latest added mods; + - Get latest updated mods; + - Get all updated mods in a specific period of time; + - Get trending mods; + - Search for a specific mod; + - Get mod details; + - Get mod's changelogs; + - Endorse or abstain from endorsing a mod. +- Access a mod's files: + - List a mod's files; + - Get a mod's file details; + - Generate a download link for a mod's file. + +Installation +------------ + +To install *pynxm*, use pip:: + + pip install pynxm + +Users will also need an api key to login with, generate one for your account +`here `_. + +Application developers that wish to use Nexus' Single Sign-On (SSO) will need an +application slug and a connection token, please contact a Nexus Community Manager +for more information. + +Quick Examples +-------------- + +Connect to Nexus:: + + >>> api_key = "my-api-key" + >>> nxm = pynxm.Nexus(api_key) + +Track a new mod:: + + >>> game = "fallout3" + >>> mod_id = "00000" + >>> nxm.user_tracked_add(game, mod_id) + +Endorse a mod:: + + >>> game = "newvegas" + >>> mod_id = "99999" + >>> nxm.mod_endorse(game, mod_id) + +Documentation +------------- + +For more information check out *pynxm*'s API documentation at `pynxm.rtfd.io `_ + +You can supplement *pynxm*'s API docs with the +`Nexus API documentation `_. + +Issues +------ + +Please use the `GitHub issue tracker `_ to submit bugs or request features. + +Development +----------- + +Setup a virtualenv, install `flit` and run:: + + flit install -s + +This will install an editable version of *pynxm* and all dev packages. + +To run the checks and tests:: + + tox + +And to publish:: + + flit publish diff --git a/appveyor.yml b/appveyor.yml new file mode 100644 index 0000000..5a6e8d2 --- /dev/null +++ b/appveyor.yml @@ -0,0 +1,17 @@ +version: '{build}' + +environment: + matrix: + - PYTHON: "C:\\Python36" + - PYTHON: "C:\\Python36-x64" + - PYTHON: "C:\\Python37" + - PYTHON: "C:\\Python37-x64" + +install: + - '%PYTHON%\\python.exe -m pip install -U pip' + - '%PYTHON%\\python.exe -m pip install tox' + +build: off + +test_script: + - '%PYTHON%\\python.exe -m tox -e check,py' diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..298ea9e --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,19 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..8ab5450 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,192 @@ +# -*- coding: utf-8 -*- +# +# Configuration file for the Sphinx documentation builder. +# +# This file does only contain a selection of the most common options. For a +# full list see the documentation: +# http://www.sphinx-doc.org/en/master/config + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import os +import sys +sys.path.insert(0, os.path.abspath('..')) + + +# -- Project information ----------------------------------------------------- + +project = 'pynxm' +copyright = '2019, Daniel Nunes' +author = 'Daniel Nunes' + +# The short X.Y version +version = '0.1.0' +# The full version, including alpha/beta/rc tags +release = version + + +# -- General configuration --------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.intersphinx', + 'sphinx.ext.viewcode', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = None + + +# -- Options for HTML output ------------------------------------------------- + +# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org +on_rtd = os.environ.get('READTHEDOCS', None) == 'True' + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +# html_theme = 'alabaster' + +if not on_rtd: # only import and set the theme if we're building docs locally + import sphinx_rtd_theme + html_theme = 'sphinx_rtd_theme' + html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# The default sidebars (for documents that don't match any pattern) are +# defined by theme itself. Builtin themes are using these templates by +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', +# 'searchbox.html']``. +# +# html_sidebars = {} + + +# -- Options for HTMLHelp output --------------------------------------------- + +# Output file base name for HTML help builder. +htmlhelp_basename = 'pynxmdoc' + + +# -- Options for LaTeX output ------------------------------------------------ + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'pynxm.tex', 'pynxm Documentation', + 'Daniel Nunes', 'manual'), +] + + +# -- Options for manual page output ------------------------------------------ + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'pynxm', 'pynxm Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ---------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'pynxm', 'pynxm Documentation', + author, 'pynxm', 'One line description of project.', + 'Miscellaneous'), +] + + +# -- Options for Epub output ------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = project + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +# +# epub_identifier = '' + +# A unique identification for the text. +# +# epub_uid = '' + +# A list of files that should not be packed into the epub file. +epub_exclude_files = ['search.html'] + + +# -- Extension configuration ------------------------------------------------- + +# -- Options for intersphinx extension --------------------------------------- + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'https://docs.python.org/': None} diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..66a7a17 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,7 @@ +API Documentation +================= + +.. automodule:: pynxm + :members: + :undoc-members: + :member-order: bysource diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..7893348 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% + +:end +popd diff --git a/pynxm.py b/pynxm.py new file mode 100644 index 0000000..b949883 --- /dev/null +++ b/pynxm.py @@ -0,0 +1,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) + ) diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..6e2dc6a --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,27 @@ +[build-system] +requires = ["flit"] +build-backend = "flit.buildapi" + +[tool.flit.metadata] +module = "pynxm" +author = "Daniel Nunes" +author-email = "daniel.henri.nunes@gmail.com" +home-page = "https://github.com/GandaG/pynexus" +description-file = "README.rst" +classifiers = [ + "Intended Audience :: Developers", + "License :: OSI Approved :: Apache Software License", + "Programming Language :: Python :: 2", + "Programming Language :: Python :: 3", + "Topic :: Software Development :: Libraries", +] +requires = [ + "requests", + "websocket-client", +] + +[tool.flit.metadata.requires-extra] +dev = [ + "tox", + "bump2version", +] diff --git a/test_pynxm.py b/test_pynxm.py new file mode 100644 index 0000000..d2ce038 --- /dev/null +++ b/test_pynxm.py @@ -0,0 +1,219 @@ +import pynxm +import pytest +import responses + +TEST_INSTANCE = pynxm.Nexus("test-key") +TEST_JSON = {"test": "content"} + + +@responses.activate +def test_errors(): + responses.add( + responses.GET, + pynxm.BASE_URL + "test_endpoint1", + json={"error": "error message"}, + status=404, + ) + with pytest.raises(pynxm.RequestError) as excinfo: + TEST_INSTANCE._make_request("get", "test_endpoint1") + assert excinfo.value == "error message" + responses.add( + responses.GET, + pynxm.BASE_URL + "test_endpoint2", + json={"message": "error message"}, + status=422, + ) + with pytest.raises(pynxm.RequestError) as excinfo: + TEST_INSTANCE._make_request("get", "test_endpoint2") + assert excinfo.value == "error message" + responses.add(responses.GET, pynxm.BASE_URL + "test_endpoint3", status=429) + with pytest.raises(pynxm.LimitReachedError) as excinfo: + TEST_INSTANCE._make_request("get", "test_endpoint3") + assert ( + excinfo.value == "You have reached your request limit. " + "Please wait one hour before trying again." + ) + + +@responses.activate +def test_colour_schemes_list(): + responses.add(responses.GET, pynxm.BASE_URL + "colourschemes.json", json=TEST_JSON) + assert TEST_INSTANCE.colour_schemes_list() == TEST_JSON + + +@responses.activate +def test_user_details(): + responses.add(responses.GET, pynxm.BASE_URL + "users/validate.json", json=TEST_JSON) + assert TEST_INSTANCE.user_details() == TEST_JSON + + +@responses.activate +def test_user_tracked_list(): + responses.add( + responses.GET, pynxm.BASE_URL + "user/tracked_mods.json", json=TEST_JSON + ) + assert TEST_INSTANCE.user_tracked_list() == TEST_JSON + + +@responses.activate +def test_user_tracked_add(): + test_url = pynxm.BASE_URL + "user/tracked_mods.json" + responses.add(responses.POST, test_url, json=TEST_JSON) + TEST_INSTANCE.user_tracked_add("game", "mod_id") + request = responses.calls[0].request + assert request.headers.get("content-type") == "application/x-www-form-urlencoded" + assert request.url == test_url + "?{}={}".format("domain_name", "game") + assert request.body == "{}={}".format("mod_id", "mod_id") + + +@responses.activate +def test_user_tracked_delete(): + test_url = pynxm.BASE_URL + "user/tracked_mods.json" + responses.add(responses.DELETE, test_url, json=TEST_JSON) + TEST_INSTANCE.user_tracked_delete("game", "mod_id") + request = responses.calls[0].request + assert request.headers.get("content-type") == "application/x-www-form-urlencoded" + assert request.url == test_url + "?domain_name=game" + assert request.body == "mod_id=mod_id" + + +@responses.activate +def test_user_endorsements_list(): + responses.add( + responses.GET, pynxm.BASE_URL + "user/endorsements.json", json=TEST_JSON + ) + assert TEST_INSTANCE.user_endorsements_list() == TEST_JSON + + +@responses.activate +def test_game_details(): + responses.add(responses.GET, pynxm.BASE_URL + "games/game_id.json", json=TEST_JSON) + assert TEST_INSTANCE.game_details("game_id") == TEST_JSON + + +@responses.activate +def test_game_list(): + test_url = pynxm.BASE_URL + "games.json" + responses.add(responses.GET, test_url, json=TEST_JSON) + assert TEST_INSTANCE.game_list() == TEST_JSON + assert responses.calls[0].request.url == test_url + "?include_unapproved=False" + + +@responses.activate +def test_game_updated_list(): + test_url = pynxm.BASE_URL + "games/game_id/mods/updated.json" + responses.add(responses.GET, test_url, json=TEST_JSON) + assert TEST_INSTANCE.game_updated_list("game_id", "1d") == TEST_JSON + assert responses.calls[0].request.url == test_url + "?period=1d" + + +@responses.activate +def test_game_latest_added_list(): + responses.add( + responses.GET, + pynxm.BASE_URL + "games/game_id/mods/latest_added.json", + json=TEST_JSON, + ) + assert TEST_INSTANCE.game_latest_added_list("game_id") == TEST_JSON + + +@responses.activate +def test_game_latest_updated_list(): + responses.add( + responses.GET, + pynxm.BASE_URL + "games/game_id/mods/latest_updated.json", + json=TEST_JSON, + ) + assert TEST_INSTANCE.game_latest_updated_list("game_id") == TEST_JSON + + +@responses.activate +def test_game_trending_list(): + responses.add( + responses.GET, + pynxm.BASE_URL + "games/game_id/mods/trending.json", + json=TEST_JSON, + ) + assert TEST_INSTANCE.game_trending_list("game_id") == TEST_JSON + + +@responses.activate +def test_mod_details(): + responses.add( + responses.GET, pynxm.BASE_URL + "games/game_id/mods/mod_id.json", json=TEST_JSON + ) + assert TEST_INSTANCE.mod_details("game_id", "mod_id") == TEST_JSON + + +@responses.activate +def test_mod_search(): + responses.add( + responses.GET, pynxm.BASE_URL + "games/game_id/mods/mod_id.json", json=TEST_JSON + ) + assert TEST_INSTANCE.mod_details("game_id", "mod_id") == TEST_JSON + + +@responses.activate +def test_mod_endorse(): + responses.add( + responses.POST, + pynxm.BASE_URL + "games/game_id/mods/mod_id/endorse.json", + json=TEST_JSON, + ) + assert TEST_INSTANCE.mod_endorse("game_id", "mod_id") == TEST_JSON + + +@responses.activate +def test_mod_abstain(): + responses.add( + responses.POST, + pynxm.BASE_URL + "games/game_id/mods/mod_id/abstain.json", + json=TEST_JSON, + ) + assert TEST_INSTANCE.mod_abstain("game_id", "mod_id") == TEST_JSON + + +@responses.activate +def test_mod_file_list(): + test_url = pynxm.BASE_URL + "games/game_id/mods/mod_id/files.json" + responses.add(responses.GET, test_url, json=TEST_JSON) + assert ( + TEST_INSTANCE.mod_file_list("game_id", "mod_id", categories="main,update") + == TEST_JSON + ) + assert responses.calls[0].request.url == test_url + "?category=main%2Cupdate" + + +@responses.activate +def test_mod_file_details(): + responses.add( + responses.GET, + pynxm.BASE_URL + "games/game_id/mods/mod_id/files/file_id.json", + json=TEST_JSON, + ) + assert TEST_INSTANCE.mod_file_details("game_id", "mod_id", "file_id") == TEST_JSON + + +@responses.activate +def test_mod_file_download_link(): + test_url = ( + pynxm.BASE_URL + "games/game_id/mods/mod_id/files/file_id/download_link.json" + ) + responses.add(responses.GET, test_url, json=TEST_JSON) + assert ( + TEST_INSTANCE.mod_file_download_link( + "game_id", "mod_id", "file_id", nxm_key="key", expires="expires" + ) + == TEST_JSON + ) + assert responses.calls[0].request.url == test_url + "?key=key&expires=expires" + + +@responses.activate +def test_mod_changelog_list(): + responses.add( + responses.GET, + pynxm.BASE_URL + "games/game_id/mods/mod_id/changelogs.json", + json=TEST_JSON, + ) + assert TEST_INSTANCE.mod_changelog_list("game_id", "mod_id") == TEST_JSON diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..10108a6 --- /dev/null +++ b/tox.ini @@ -0,0 +1,40 @@ +[tox] +isolated_build = true +isolated_build_env = py3 +envlist = + check, + py, + +[testenv] +deps = + pytest + pytest-cov + pytest-sugar + responses +passenv = + * +commands = + pytest {posargs} -rsx test_pynxm.py + +[testenv:check] +skip_install = true +deps = + isort + black + flake8 + flake8-bugbear +commands = + isort -m 3 -tc -fgw 0 -up -w 88 -rc pynxm.py test_pynxm.py + black pynxm.py test_pynxm.py + flake8 --max-line-length=80 --select=C,E,F,W,B,B950 --ignore=E501,W503 pynxm.py test_pynxm.py + +[testenv:docs] +changedir = docs +whitelist_externals = + make +deps = + sphinx + sphinx-rtd-theme +commands = + make html + make linkcheck