Rossen Georgiev
9 years ago
12 changed files with 970 additions and 0 deletions
@ -0,0 +1,3 @@ |
|||
_doc |
|||
_static |
|||
_templates |
|||
@ -0,0 +1,216 @@ |
|||
# Makefile for Sphinx documentation
|
|||
#
|
|||
|
|||
# You can set these variables from the command line.
|
|||
SPHINXOPTS = |
|||
SPHINXBUILD = sphinx-build |
|||
PAPER = |
|||
BUILDDIR = _build |
|||
|
|||
# User-friendly check for sphinx-build
|
|||
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) |
|||
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don\'t have Sphinx installed, grab it from http://sphinx-doc.org/) |
|||
endif |
|||
|
|||
# Internal variables.
|
|||
PAPEROPT_a4 = -D latex_paper_size=a4 |
|||
PAPEROPT_letter = -D latex_paper_size=letter |
|||
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . |
|||
# the i18n builder cannot share the environment and doctrees with the others
|
|||
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . |
|||
|
|||
.PHONY: help |
|||
help: |
|||
@echo "Please use \`make <target>' where <target> is one of" |
|||
@echo " html to make standalone HTML files" |
|||
@echo " dirhtml to make HTML files named index.html in directories" |
|||
@echo " singlehtml to make a single large HTML file" |
|||
@echo " pickle to make pickle files" |
|||
@echo " json to make JSON files" |
|||
@echo " htmlhelp to make HTML files and a HTML help project" |
|||
@echo " qthelp to make HTML files and a qthelp project" |
|||
@echo " applehelp to make an Apple Help Book" |
|||
@echo " devhelp to make HTML files and a Devhelp project" |
|||
@echo " epub to make an epub" |
|||
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" |
|||
@echo " latexpdf to make LaTeX files and run them through pdflatex" |
|||
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" |
|||
@echo " text to make text files" |
|||
@echo " man to make manual pages" |
|||
@echo " texinfo to make Texinfo files" |
|||
@echo " info to make Texinfo files and run them through makeinfo" |
|||
@echo " gettext to make PO message catalogs" |
|||
@echo " changes to make an overview of all changed/added/deprecated items" |
|||
@echo " xml to make Docutils-native XML files" |
|||
@echo " pseudoxml to make pseudoxml-XML files for display purposes" |
|||
@echo " linkcheck to check all external links for integrity" |
|||
@echo " doctest to run all doctests embedded in the documentation (if enabled)" |
|||
@echo " coverage to run coverage check of the documentation (if enabled)" |
|||
|
|||
.PHONY: clean |
|||
clean: |
|||
rm -rf $(BUILDDIR)/* |
|||
|
|||
.PHONY: html |
|||
html: |
|||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html |
|||
@echo |
|||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html." |
|||
|
|||
.PHONY: dirhtml |
|||
dirhtml: |
|||
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml |
|||
@echo |
|||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." |
|||
|
|||
.PHONY: singlehtml |
|||
singlehtml: |
|||
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml |
|||
@echo |
|||
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." |
|||
|
|||
.PHONY: pickle |
|||
pickle: |
|||
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle |
|||
@echo |
|||
@echo "Build finished; now you can process the pickle files." |
|||
|
|||
.PHONY: json |
|||
json: |
|||
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json |
|||
@echo |
|||
@echo "Build finished; now you can process the JSON files." |
|||
|
|||
.PHONY: htmlhelp |
|||
htmlhelp: |
|||
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp |
|||
@echo |
|||
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
|||
".hhp project file in $(BUILDDIR)/htmlhelp." |
|||
|
|||
.PHONY: qthelp |
|||
qthelp: |
|||
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp |
|||
@echo |
|||
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
|||
".qhcp project file in $(BUILDDIR)/qthelp, like this:" |
|||
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/steam.qhcp" |
|||
@echo "To view the help file:" |
|||
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/steam.qhc" |
|||
|
|||
.PHONY: applehelp |
|||
applehelp: |
|||
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp |
|||
@echo |
|||
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp." |
|||
@echo "N.B. You won't be able to view it unless you put it in" \
|
|||
"~/Library/Documentation/Help or install it in your application" \
|
|||
"bundle." |
|||
|
|||
.PHONY: devhelp |
|||
devhelp: |
|||
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp |
|||
@echo |
|||
@echo "Build finished." |
|||
@echo "To view the help file:" |
|||
@echo "# mkdir -p $$HOME/.local/share/devhelp/steam" |
|||
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/steam" |
|||
@echo "# devhelp" |
|||
|
|||
.PHONY: epub |
|||
epub: |
|||
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub |
|||
@echo |
|||
@echo "Build finished. The epub file is in $(BUILDDIR)/epub." |
|||
|
|||
.PHONY: latex |
|||
latex: |
|||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex |
|||
@echo |
|||
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." |
|||
@echo "Run \`make' in that directory to run these through (pdf)latex" \
|
|||
"(use \`make latexpdf' here to do that automatically)." |
|||
|
|||
.PHONY: latexpdf |
|||
latexpdf: |
|||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex |
|||
@echo "Running LaTeX files through pdflatex..." |
|||
$(MAKE) -C $(BUILDDIR)/latex all-pdf |
|||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." |
|||
|
|||
.PHONY: latexpdfja |
|||
latexpdfja: |
|||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex |
|||
@echo "Running LaTeX files through platex and dvipdfmx..." |
|||
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja |
|||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." |
|||
|
|||
.PHONY: text |
|||
text: |
|||
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text |
|||
@echo |
|||
@echo "Build finished. The text files are in $(BUILDDIR)/text." |
|||
|
|||
.PHONY: man |
|||
man: |
|||
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man |
|||
@echo |
|||
@echo "Build finished. The manual pages are in $(BUILDDIR)/man." |
|||
|
|||
.PHONY: texinfo |
|||
texinfo: |
|||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo |
|||
@echo |
|||
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." |
|||
@echo "Run \`make' in that directory to run these through makeinfo" \
|
|||
"(use \`make info' here to do that automatically)." |
|||
|
|||
.PHONY: info |
|||
info: |
|||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo |
|||
@echo "Running Texinfo files through makeinfo..." |
|||
make -C $(BUILDDIR)/texinfo info |
|||
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." |
|||
|
|||
.PHONY: gettext |
|||
gettext: |
|||
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale |
|||
@echo |
|||
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." |
|||
|
|||
.PHONY: changes |
|||
changes: |
|||
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes |
|||
@echo |
|||
@echo "The overview file is in $(BUILDDIR)/changes." |
|||
|
|||
.PHONY: linkcheck |
|||
linkcheck: |
|||
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck |
|||
@echo |
|||
@echo "Link check complete; look for any errors in the above output " \
|
|||
"or in $(BUILDDIR)/linkcheck/output.txt." |
|||
|
|||
.PHONY: doctest |
|||
doctest: |
|||
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest |
|||
@echo "Testing of doctests in the sources finished, look at the " \
|
|||
"results in $(BUILDDIR)/doctest/output.txt." |
|||
|
|||
.PHONY: coverage |
|||
coverage: |
|||
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage |
|||
@echo "Testing of coverage in the sources finished, look at the " \
|
|||
"results in $(BUILDDIR)/coverage/python.txt." |
|||
|
|||
.PHONY: xml |
|||
xml: |
|||
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml |
|||
@echo |
|||
@echo "Build finished. The XML files are in $(BUILDDIR)/xml." |
|||
|
|||
.PHONY: pseudoxml |
|||
pseudoxml: |
|||
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml |
|||
@echo |
|||
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." |
|||
@ -0,0 +1,5 @@ |
|||
API Reference |
|||
************* |
|||
|
|||
.. toctree:: |
|||
steam |
|||
@ -0,0 +1,25 @@ |
|||
steam.client |
|||
============ |
|||
|
|||
.. automodule:: steam.client |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
steam.client.gc |
|||
--------------- |
|||
|
|||
.. automodule:: steam.client.gc |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
steam.client.jobs |
|||
----------------- |
|||
|
|||
.. automodule:: steam.client.jobs |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
|
|||
@ -0,0 +1,41 @@ |
|||
steam.core |
|||
========== |
|||
|
|||
.. automodule:: steam.core |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
steam.core.cm |
|||
------------- |
|||
|
|||
.. automodule:: steam.core.cm |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
steam.core.connection |
|||
--------------------- |
|||
|
|||
.. automodule:: steam.core.connection |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
steam.core.crypto |
|||
----------------- |
|||
|
|||
.. automodule:: steam.core.crypto |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
steam.core.msg |
|||
-------------- |
|||
|
|||
.. automodule:: steam.core.msg |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
|
|||
@ -0,0 +1,33 @@ |
|||
steam.enums |
|||
=========== |
|||
|
|||
.. automodule:: steam.enums |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
steam.enums.base |
|||
---------------- |
|||
|
|||
.. automodule:: steam.enums.base |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
steam.enums.common |
|||
------------------ |
|||
|
|||
.. automodule:: steam.enums.common |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
steam.enums.emsg |
|||
---------------- |
|||
|
|||
.. automodule:: steam.enums.emsg |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
|
|||
@ -0,0 +1,32 @@ |
|||
steam |
|||
===== |
|||
|
|||
.. automodule:: steam |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
.. toctree:: |
|||
|
|||
steam.client |
|||
steam.core |
|||
steam.enums |
|||
steam.util |
|||
|
|||
steam.steamid |
|||
------------- |
|||
|
|||
.. automodule:: steam.steamid |
|||
:members: SteamID, from_url, steam64_from_url, steam2_to_tuple, steam3_to_tuple |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
steam.webapi |
|||
------------ |
|||
|
|||
.. automodule:: steam.webapi |
|||
:members: WebAPI |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
|
|||
@ -0,0 +1,17 @@ |
|||
steam.util |
|||
========== |
|||
|
|||
.. automodule:: steam.util |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
steam.util.events |
|||
----------------- |
|||
|
|||
.. automodule:: steam.util.events |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
|
|||
@ -0,0 +1,288 @@ |
|||
# -*- coding: utf-8 -*- |
|||
# |
|||
# steam documentation build configuration file, created by |
|||
# sphinx-quickstart on Sun Jan 17 23:28:57 2016. |
|||
# |
|||
# 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. |
|||
|
|||
import sys |
|||
import os |
|||
|
|||
# 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. |
|||
sys.path.insert(0, os.path.abspath('../')) |
|||
|
|||
# -- 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.githubpages', |
|||
] |
|||
|
|||
# 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 encoding of source files. |
|||
#source_encoding = 'utf-8-sig' |
|||
|
|||
# The master toctree document. |
|||
master_doc = 'index' |
|||
|
|||
# General information about the project. |
|||
project = u'steam' |
|||
copyright = u'2016, Rossen Georgiev' |
|||
author = u'Rossen Georgiev' |
|||
|
|||
# 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 = u'0.6.0' |
|||
# The full version, including alpha/beta/rc tags. |
|||
release = u'0.6.0a' |
|||
|
|||
# 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 |
|||
|
|||
# There are two options for replacing |today|: either, you set today to some |
|||
# non-false value, then it is used: |
|||
#today = '' |
|||
# Else, today_fmt is used as the format for a strftime call. |
|||
#today_fmt = '%B %d, %Y' |
|||
|
|||
# List of patterns, relative to source directory, that match files and |
|||
# directories to ignore when looking for source files. |
|||
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
|||
|
|||
# The reST default role (used for this markup: `text`) to use for all |
|||
# documents. |
|||
#default_role = None |
|||
|
|||
# If true, '()' will be appended to :func: etc. cross-reference text. |
|||
#add_function_parentheses = True |
|||
|
|||
# If true, the current module name will be prepended to all description |
|||
# unit titles (such as .. function::). |
|||
#add_module_names = True |
|||
|
|||
# If true, sectionauthor and moduleauthor directives will be shown in the |
|||
# output. They are ignored by default. |
|||
#show_authors = False |
|||
|
|||
# The name of the Pygments (syntax highlighting) style to use. |
|||
pygments_style = 'sphinx' |
|||
|
|||
# A list of ignored prefixes for module index sorting. |
|||
#modindex_common_prefix = [] |
|||
|
|||
# If true, keep warnings as "system message" paragraphs in the built documents. |
|||
#keep_warnings = False |
|||
|
|||
# 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 = 'classic' |
|||
|
|||
# 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 themes here, relative to this directory. |
|||
#html_theme_path = [] |
|||
|
|||
# The name for this set of Sphinx documents. |
|||
# "<project> v<release> documentation" by default. |
|||
#html_title = u'steam v0.5.4' |
|||
|
|||
# A shorter title for the navigation bar. Default is the same as html_title. |
|||
#html_short_title = None |
|||
|
|||
# The name of an image file (relative to this directory) to place at the top |
|||
# of the sidebar. |
|||
#html_logo = None |
|||
|
|||
# The name of an image file (within the static path) to use as favicon of the |
|||
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
|||
# pixels large. |
|||
#html_favicon = None |
|||
|
|||
# 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'] |
|||
|
|||
# Add any extra paths that contain custom files (such as robots.txt or |
|||
# .htaccess) here, relative to this directory. These files are copied |
|||
# directly to the root of the documentation. |
|||
#html_extra_path = [] |
|||
|
|||
# If not None, a 'Last updated on:' timestamp is inserted at every page |
|||
# bottom, using the given strftime format. |
|||
# The empty string is equivalent to '%b %d, %Y'. |
|||
#html_last_updated_fmt = None |
|||
|
|||
# If true, SmartyPants will be used to convert quotes and dashes to |
|||
# typographically correct entities. |
|||
#html_use_smartypants = True |
|||
|
|||
# Custom sidebar templates, maps document names to template names. |
|||
#html_sidebars = {} |
|||
|
|||
# Additional templates that should be rendered to pages, maps page names to |
|||
# template names. |
|||
#html_additional_pages = {} |
|||
|
|||
# If false, no module index is generated. |
|||
#html_domain_indices = True |
|||
|
|||
# If false, no index is generated. |
|||
#html_use_index = True |
|||
|
|||
# If true, the index is split into individual pages for each letter. |
|||
#html_split_index = False |
|||
|
|||
# If true, links to the reST sources are added to the pages. |
|||
html_show_sourcelink = False |
|||
|
|||
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
|||
html_show_sphinx = True |
|||
|
|||
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
|||
html_show_copyright = True |
|||
|
|||
# If true, an OpenSearch description file will be output, and all pages will |
|||
# contain a <link> tag referring to it. The value of this option must be the |
|||
# base URL from which the finished HTML is served. |
|||
#html_use_opensearch = '' |
|||
|
|||
# This is the file name suffix for HTML files (e.g. ".xhtml"). |
|||
#html_file_suffix = None |
|||
|
|||
# Language to be used for generating the HTML full-text search index. |
|||
# Sphinx supports the following languages: |
|||
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' |
|||
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh' |
|||
#html_search_language = 'en' |
|||
|
|||
# A dictionary with options for the search language support, empty by default. |
|||
# 'ja' uses this config value. |
|||
# 'zh' user can custom change `jieba` dictionary path. |
|||
#html_search_options = {'type': 'default'} |
|||
|
|||
# The name of a javascript file (relative to the configuration directory) that |
|||
# implements a search results scorer. If empty, the default will be used. |
|||
#html_search_scorer = 'scorer.js' |
|||
|
|||
# Output file base name for HTML help builder. |
|||
htmlhelp_basename = 'steamdoc' |
|||
|
|||
# -- 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, 'steam.tex', u'steam Documentation', |
|||
u'Rossen Georgiev', 'manual'), |
|||
] |
|||
|
|||
# The name of an image file (relative to this directory) to place at the top of |
|||
# the title page. |
|||
#latex_logo = None |
|||
|
|||
# For "manual" documents, if this is true, then toplevel headings are parts, |
|||
# not chapters. |
|||
#latex_use_parts = False |
|||
|
|||
# If true, show page references after internal links. |
|||
#latex_show_pagerefs = False |
|||
|
|||
# If true, show URL addresses after external links. |
|||
#latex_show_urls = False |
|||
|
|||
# Documents to append as an appendix to all manuals. |
|||
#latex_appendices = [] |
|||
|
|||
# If false, no module index is generated. |
|||
#latex_domain_indices = True |
|||
|
|||
|
|||
# -- 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, 'steam', u'steam Documentation', |
|||
[author], 1) |
|||
] |
|||
|
|||
# If true, show URL addresses after external links. |
|||
#man_show_urls = False |
|||
|
|||
|
|||
# -- 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, 'steam', u'steam Documentation', |
|||
author, 'steam', 'One line description of project.', |
|||
'Miscellaneous'), |
|||
] |
|||
|
|||
# Documents to append as an appendix to all manuals. |
|||
#texinfo_appendices = [] |
|||
|
|||
# If false, no module index is generated. |
|||
#texinfo_domain_indices = True |
|||
|
|||
# How to display URL addresses: 'footnote', 'no', or 'inline'. |
|||
#texinfo_show_urls = 'footnote' |
|||
|
|||
# If true, do not generate a @detailmenu in the "Top" node's menu. |
|||
#texinfo_no_detailmenu = False |
|||
@ -0,0 +1,24 @@ |
|||
.. _Steam: https://store.steampowered.com/ |
|||
.. _Steam Web API: https://developer.valvesoftware.com/wiki/Steam_Web_API |
|||
.. _API Key: http://steamcommunity.com/dev/apikey |
|||
|
|||
.. |pypi| image:: https://img.shields.io/pypi/v/steam.svg?style=flat&label=pypi%20version |
|||
:target: https://pypi.python.org/pypi/steam |
|||
:alt: Latest version released on PyPi |
|||
|
|||
.. |license| image:: https://img.shields.io/pypi/l/steam.svg?style=flat&label=license |
|||
:target: https://pypi.python.org/pypi/steam |
|||
:alt: MIT License |
|||
|
|||
.. |coverage| image:: https://img.shields.io/coveralls/ValvePython/steam/master.svg?style=flat |
|||
:target: https://coveralls.io/r/ValvePython/steam?branch=master |
|||
:alt: Test coverage |
|||
|
|||
.. |scru| image:: https://scrutinizer-ci.com/g/ValvePython/steam/badges/quality-score.png?b=master |
|||
:target: https://scrutinizer-ci.com/g/ValvePython/steam/?branch=master |
|||
:alt: Scrutinizer score |
|||
|
|||
.. |master_build| image:: https://img.shields.io/travis/ValvePython/steam/master.svg?style=flat&label=master |
|||
:target: http://travis-ci.org/ValvePython/steam |
|||
:alt: Build status of master branch |
|||
|
|||
@ -0,0 +1,52 @@ |
|||
.. include:: global.rst |
|||
|
|||
``steam`` module documentation |
|||
****************************** |
|||
|
|||
|pypi| |license| |
|||
|
|||
|
|||
A python module for intracting with various parts of Steam_. |
|||
|
|||
.. note:: |
|||
The module is still very much an alpha. |
|||
API can change without warning |
|||
|
|||
.. note:: |
|||
Python 3 is currently not supported, |
|||
see `milestone <https://github.com/ValvePython/steam/milestones/Python%203%20support>`_. |
|||
|
|||
Installing |
|||
========== |
|||
|
|||
The latest relase version can be installed from ``PYPI``:: |
|||
|
|||
pip install -U steam |
|||
|
|||
To install the current dev version from `Github repository <https://github.com/ValvePython/steam>`_:: |
|||
|
|||
pip install git+https://github.com/ValvePython/steam |
|||
|
|||
Contributing |
|||
============ |
|||
|
|||
Issues, suggestions, and code contributions are welcome. |
|||
Just head on to the `Github repostory <https://github.com/ValvePython/steam>`_. |
|||
|
|||
Table of contents |
|||
================= |
|||
|
|||
.. toctree:: |
|||
:maxdepth: 3 |
|||
|
|||
quick_start |
|||
api/index |
|||
|
|||
|
|||
Indices and tables |
|||
================== |
|||
|
|||
* :ref:`genindex` |
|||
* :ref:`modindex` |
|||
* :ref:`search` |
|||
|
|||
@ -0,0 +1,234 @@ |
|||
.. include:: global.rst |
|||
|
|||
Quick start |
|||
*********** |
|||
|
|||
Welcome to the quick start section. |
|||
The aim here is to give you a very quick |
|||
overview of the functionality available in the ``steam`` module. |
|||
|
|||
SteamID |
|||
======= |
|||
|
|||
``SteamID`` object can be used to convert the universal steam id |
|||
to its' various representations. |
|||
|
|||
.. note:: |
|||
``SteamID`` is immutable as it inherits from ``int``. |
|||
|
|||
Example usage |
|||
------------- |
|||
|
|||
.. code:: python |
|||
|
|||
>>> from steam import SteamID |
|||
|
|||
>>> SteamID() |
|||
SteamID(id=0, type='Invalid', universe='Invalid', instance=0) |
|||
|
|||
>>> SteamID(12345) # accountid |
|||
>>> SteamID('12345') |
|||
>>> SteamID('STEAM_1:1:6172') # steam2 |
|||
SteamID(id=12345, type='Individual', universe='Public', instance=1) |
|||
|
|||
>>> SteamID(103582791429521412) # steam64 |
|||
>>> SteamID('103582791429521412') |
|||
>>> SteamID('[g:1:4]') # steam3 |
|||
SteamID(id=4, type='Clan', universe='Public', instance=0) |
|||
>>> group = SteamID('[g:1:4]') |
|||
>>> group.id # accountid |
|||
4 |
|||
>>> group.as_32 # accountid |
|||
4 |
|||
>>> group.as_64 |
|||
103582791429521412 |
|||
>>> int(group) |
|||
103582791429521412 |
|||
>>> str(group) |
|||
'103582791429521412' |
|||
>>> group.as_steam2 # only works for 'Individual' accounts |
|||
'STEAM_1:0:2' |
|||
>>> group.as_steam3 |
|||
'[g:1:4]' |
|||
>>> group.community_url |
|||
'https://steamcommunity.com/gid/103582791429521412' |
|||
|
|||
|
|||
Resolving community urls to ``SteamID`` |
|||
----------------------------------------- |
|||
|
|||
The ``steamid`` submodule provides function to resolve community urls. |
|||
Here are some examples: |
|||
|
|||
.. code:: python |
|||
|
|||
>>> steam.steamid.from_url('https://steamcommunity.com/id/drunkenf00l') |
|||
>>> steam.steamid.from_url('http://steamcommunity.com/profiles/76561197968459473') |
|||
SteamID(id=8193745, type='Individual', universe='Public', instance=1) |
|||
|
|||
>>> steam.steamid.steam64_from_url('http://steamcommunity.com/profiles/76561197968459473') |
|||
'76561197968459473' |
|||
|
|||
|
|||
WebAPI |
|||
====== |
|||
|
|||
Wrapper around `Steam Web API`_. Requires `API Key`_. Upon initialization the |
|||
instance will fetch all available interfaces from the API and populate the namespace. |
|||
|
|||
.. note:: |
|||
Interface availability depends on the ``key``. |
|||
Unless data is loaded manually. |
|||
|
|||
Example usage |
|||
------------- |
|||
|
|||
.. code:: python |
|||
|
|||
>>> from steam import WebAPI |
|||
>>> api = WebAPI(key="<your api key>") |
|||
|
|||
# instance.<interface>.<method> |
|||
>>> api.ISteamWebAPIUtil.GetServerInfo() |
|||
>>> api.call('ISteamWebAPIUtil.GetServerInfo') |
|||
{u'servertimestring': u'Sun Jul 05 22:37:25 2015', u'servertime': 1436161045} |
|||
|
|||
>>> api.ISteamUser.ResolveVanityURL(vanityurl="valve", url_type=2) |
|||
>>> api.call('ISteamUser.ResolveVanityURL', vanityurl="valve", url_type=2) |
|||
{u'response': {u'steamid': u'103582791429521412', u'success': 1}} |
|||
|
|||
# call a specific version of the method |
|||
>>> api.ISteamUser.ResolveVanityURL_v1(vanityurl="valve", url_type=2) |
|||
>>> api.call('ISteamUser.ResolveVanityURL_v1', vanityurl="valve", url_type=2) |
|||
|
|||
It's not necessary to provide the key when calling any interface method. |
|||
``key``, ``format``, ``raw``, ``http_timeout`` parameters can be specified on ``WebAPI`` to affect |
|||
all method calls, or when calling a specific method. |
|||
Some methods have parameters which need to be a ``list``. |
|||
Trying to call nonexistent method will raise an ``AttributeError``. |
|||
|
|||
Supported formats by web api are: ``json`` (default), ``vdf``, ``xml`` |
|||
The response will be deserialized using the appropriate module unless ``raw`` is |
|||
``True``. |
|||
|
|||
WebAPI documentation |
|||
-------------------- |
|||
|
|||
.. code:: python |
|||
|
|||
>>> api.ISteamUser.ResolveVanityURL.__doc__ # method doc |
|||
""" |
|||
ResolveVanityURL (v0001) |
|||
|
|||
Parameters: |
|||
key string required |
|||
- access key |
|||
url_type int32 optional |
|||
- The type of vanity URL. 1 (default): Individual profile, 2: Group, 3: Official game group |
|||
vanityurl string required |
|||
- The vanity URL to get a SteamID for |
|||
|
|||
""" |
|||
|
|||
# or calling doc() will print it |
|||
>>> api.ISteamUser.ResolveVanityURL.doc() # method doc |
|||
>>> api.ISteamUser.doc() # interface and all methods |
|||
>>> api.doc() # all available interfaces |
|||
|
|||
|
|||
For a more complete list of all available interfaces and methods visit: |
|||
https://lab.xpaw.me/steam_api_documentation.html |
|||
|
|||
|
|||
SteamClient |
|||
=========== |
|||
|
|||
``gevent`` based implementation for interacting with the Steam network. |
|||
This is currently a WIP, and is barebone. |
|||
It should be possible to implement various functions with ease. |
|||
|
|||
.. warning:: |
|||
API for this part could change without notice |
|||
|
|||
CLI example |
|||
----------- |
|||
|
|||
This program will prompt for user and password. |
|||
If authentication code is required, it will additionally prompt for that. |
|||
Configuring logging will lets us see the internal interactions. |
|||
|
|||
.. code:: python |
|||
|
|||
import logging |
|||
from getpass import getpass |
|||
logging.basicConfig(format='[%(asctime)s] %(levelname)s %(name)s: %(message)s', level=logging.DEBUG) |
|||
|
|||
from steam import SteamClient |
|||
from steam.enums import EResult |
|||
from steam.enums.emsg import EMsg |
|||
|
|||
client = SteamClient() |
|||
#client.cm.verbose_debug = True |
|||
|
|||
@client.on('error') |
|||
def print_error(result): |
|||
print "Error:", EResult(result) |
|||
|
|||
@client.on('auth_code_required') |
|||
def auth_code_prompt(eresult): |
|||
if eresult == EResult.AccountLogonDenied: |
|||
code = raw_input("Enter Email Code: ") |
|||
logOnDetails.update({'auth_code': code}) |
|||
else: |
|||
code = raw_input("Enter 2FA Code: ") |
|||
logOnDetails.update({'two_factor_code': code}) |
|||
|
|||
client.login(**logOnDetails) |
|||
|
|||
logOnDetails = { |
|||
'username': raw_input("Steam user: "), |
|||
'password': getpass("Password: "), |
|||
} |
|||
|
|||
client.login(**logOnDetails) |
|||
# OR |
|||
# client.anonymous_login() |
|||
|
|||
msg = client.wait_event(EMsg.ClientAccountInfo) |
|||
print "Logged on as: %s" % msg.body.persona_name |
|||
print "SteamID: %s" % repr(client.steamid) |
|||
|
|||
client.wait_event('disconnect') |
|||
|
|||
|
|||
Sending a message |
|||
----------------- |
|||
|
|||
Example of sending a protobuf message and handling the response. |
|||
`wait_event` will block until specified event. |
|||
|
|||
.. code:: python |
|||
|
|||
from steam.core.emsg import MsgProto |
|||
|
|||
message = MsgProto(EMsg.ClientRequestWebAPIAuthenticateUserNonce) |
|||
client.send(message) |
|||
|
|||
resp = client.wait_event(EMsg.ClientRequestWebAPIAuthenticateUserNonceResponse) |
|||
|
|||
if resp.body.eresult == EResult.OK: |
|||
print "WebAPI Nonce: %s" % repr(resp.body.webapi_authenticate_user_nonce) |
|||
else: |
|||
print "Error: %s" % EResult(resp.body.eresult) |
|||
|
|||
|
|||
Alternatively, a callback can be registered to handle the response event every time. |
|||
|
|||
.. code:: python |
|||
|
|||
@client.on(EMsg.ClientRequestWebAPIAuthenticateUserNonceResponse) |
|||
def handle_webapi_nonce(msg): |
|||
print "WebAPI Nonce: %s" % repr(resp.body.webapi_authenticate_user_nonce) |
|||
|
|||
# OR |
|||
client.on(EMsg.ClientRequestWebAPIAuthenticateUserNonceResponse, handle_webapi_nonce) |
|||
Loading…
Reference in new issue