Initial Commit

LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Demo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,14 @@
+# <a href="https://pypi.python.org/pypi/pyvainglory">PyVainglory</a>
+
+A python wrapper for madglory's [Vainglory API](http://battlerite-docs.readthedocs.io/en/master/introduction.html)
+complete with asynchronous and synchronous client implementations.
+
+```
+pip install pyvainglory
+```
+## Documentation
+Visit https://xkynn.github.io/PyVainglory/ for docs, thanks!
+
+### Contact
+Demo#9465 on Discord
+[@Craft_Eternal36](https://twitter.com/Craft_Eternal36) on Twitter

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = AsyncBattlerite
+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)

docs/conf.py

@@ -0,0 +1,169 @@
+#!/usr/bin/env python3
+#
+# -*- coding: utf-8 -*-
+# PyBattlerite documentation build configuration file, created by
+# sphinx-quickstart on Thu Dec  7 11:29:05 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+# 
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# 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 sys
+import os
+#import PyBattlerite
+sys.path.insert(0, os.path.abspath('../'))
+
+numpydoc_show_class_members = False
+# -- 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', 'numpydoc', 'sphinx.ext.autosummary']
+# 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'
+
+# General information about the project.
+project = 'PyBattlerite'
+copyright = '2017, PyBattlerite'
+author = 'PyBattlerite'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.5'
+# The full version, including alpha/beta/rc tags.
+release = '0.5.17'
+
+# 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 patterns also effect to 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 = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'bizstyle'
+
+# 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.
+#
+# This is required for the alabaster theme
+# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
+html_sidebars = {
+    '**': [
+        'relations.html',  # needs 'show_related': True theme option to display
+        'searchbox.html',
+    ]
+}
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'PyBattleritedoc'
+
+
+# -- 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, 'PyBattlerite.tex', 'PyBattlerite Documentation',
+     'PyBattlerite', '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, 'PyBattlerite', 'PyBattlerite 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, 'PyBattlerite', 'PyBattlerite Documentation',
+     author, 'PyBattlerite', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+

docs/index.rst

@@ -0,0 +1,74 @@
+Welcome to PyBattlerite's documentation!
+===========================================
+
+Basic Usage::
+
+   import pybattlerite
+   import requests
+
+   brc = pybattlerite.Client('your-api-key')
+
+   # You can also provide an aiohttp.ClientSession to the BRClient constructor
+   session = requests.Session()
+   brc_a = pybattlerite.Client('your-api-key', session)
+
+   # Get 3 matches after specified time
+   # after and before can also be datetime.datetime objects
+   matches = brc.get_matches(limit=3, after="2017-11-22T20:34:58Z")
+
+   # Go to the next pages of matches
+   matches.next()
+
+   # Get telemetry data for one of the matches
+   telemetry = matches.matches[0].get_telemetry()
+
+Async Usage::
+
+   import aiohttp
+   import asyncio
+   import pybattlerite
+
+   brc = pybattlerite.AsyncClient('your-api-key')
+
+   # You can also provide an aiohttp.ClientSession to the BRClient constructor
+   session = aiohttp.ClientSession()
+   brc_a = pybattlerite.AsyncClient('your-api-key', session)
+
+   # Get 3 matches after specified time
+   # after and before can also be datetime.datetime objects
+   matches = await brc.get_matches(limit=3, after="2017-11-22T20:34:58Z")
+
+   # Go to the next pages of matches
+   await matches.next()
+
+   # Get telemetry data for one of the matches
+   telemetry = await matches.matches[0].get_telemetry()
+
+
+pyvainglory.Client
+------------------------
+
+.. automodule:: pyvainglory.client
+    :members:
+    :show-inheritance:
+
+pyvainglory.AsyncClient
+------------------------
+
+.. automodule:: pyvainglory.asyncclient
+    :members:
+    :show-inheritance:
+
+pyvainglory.models
+----------------------
+
+.. automodule:: pyvainglory.models
+    :members:
+    :show-inheritance:
+
+pyvainglory.errors
+----------------------
+
+.. automodule:: pyvainglory.errors
+    :members:
+    :show-inheritance:

docs/req.txt

@@ -0,0 +1,4 @@
+aiohttp
+requests
+sphinx_autodoc_typehints
+numpydoc

pyvainglory/__init__.py

@@ -0,0 +1,2 @@
+from .asyncclient import AsyncClient
+from .client import Client