Skip to content

Commit

Permalink
Merge pull request #38 from ondrowan/sphinx
Browse files Browse the repository at this point in the history 
Sphinx documentation
  • Loading branch information
@Lagg
Lagg committed Jun 5, 2015
2 parents d4b9df4 + e2ef5ec commit fc50a38
Show file tree
Hide file tree
Showing 17 changed files with 1,561 additions and 97 deletions.
4 changes: 4 additions & 0 deletions .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,7 @@
build
testscript.py
.idea/*
.DS_Store

# Sphinx
docs/_build
113 changes: 22 additions & 91 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,121 +1,52 @@
# About #
# Steamodd #

Steamodd originated with an early version of OPTF2 which itself
grew out of a 200 line script I wrote in the early days of the
Steam API to find things I could complain about. Since then it
has grown into a more and more capable and fully featured module
with every version.
Steam tools library written in Python.

It is still a work in progress and the API is subject to change
in breaking ways, however as of the 3.0 release I have began using
a simple and meaningful versioning system that should make moving
to new versions much easier. Major version numbers are incremented
when the release makes breaking changes, minor version numbers
are incremented when they are not. Meaning that it is safe to
upgrade without having to change existing code.

### The name ###
## Overview ##

If there's one thing I've learned over the years and most recently
from OPTF2 it's a good idea to record the meaning behind your project
names if they aren't explicitly indicative of function or you *will*
forget.
Steamodd contains of several useful tools for working with Steam related data:

Steamodd quite simply stands for "Steam odds and ends". Even though
it's starting to become more of a robust module it started out as a small
and probably not very well designed script meant to be run as a tool instead
of a reusable lib.
* Steam API interface wrappers
* Steam inventory manager (SIM)
* VDF serializer

That's not to say that the name doesn't fit, since in
addition to the strong implementation of the API it has the recent
[VDF](http://wiki.teamfortress.com/wiki/WebAPI/VDF) support and the SIM
layer to boast as useful but not exactly unrelated utilities.

# Installing #
## Requirements ##

$ pip install steamodd

If you wish to install it manually, Steamodd uses the standard distutils
module. To install it run `python setup.py install`. For further instructions
and commands run `python setup.py --help`.

# Using #

## Steam API key ##

Before calling any methods you should set Steam API key either from code:

```python
>>> import steam
>>> steam.api.key.set(API_KEY)
```

Or set environmental variable:

$ export STEAMODD_API_KEY="your_key"
Python 2.7 or 3.3.

Most methods will not complete successfully without it. If you don't have an
API key you can register for one on [Steam](http://steamcommunity.com/dev/apikey).

## Low level API ##
## Installation ##

You can call [any method from any of Steam API interfaces](https://wiki.teamfortress.com/wiki/WebAPI#Methods)
using `steam.api.interface` class. Let's start with a quick example where we
fetch user's game library.
From command line:

Start by importing `interface` class:

```python
>>> from steam.api import interface
```

Call method `GetOwnedGames` of interface `IPlayerService`. We are going to
download games of user with id `76561198017493014` and include all application
information:

```python
>>> games = interface('IPlayerService').GetOwnedGames(steamid=76561198017493014, include_appinfo=1)
```

Since all method calls are lazy by default, this doesn't do anything at all.
We'll need to either iterate over `games`, `print` it or access any of its
dictionary keys:

```python
>>> print(games['response']['game_count']) # Fetches resource
249
```
$ pip install steamodd

Don't worry, resource isn't fetched each time you access results.
If you wish to install it manually, Steamodd uses the standard distutils
module. To install it run:

```python
>>> print(games) # Uses previously fetched resource
{'response': {'games': [{'name': 'Counter-Strike', 'playtime_forever': 1570,...
```
$ python setup.py install

You can disable lazyness of `interface` by passing `aggressive=True` to its method:

```python
>>> games = interface('IPlayerService').GetOwnedGames(steamid=76561198017493014, include_appinfo=1, aggressive=True)
```
## Documentation ##

You can also pass `since` (which translates to HTTP header `If-Modified-Since`)
and `timeout` to method. By default, `version` is set to `1` and `method` is
`GET`. Any number of additional keyword arguments is supported, depending on
given method (see [documentation](https://wiki.teamfortress.com/wiki/WebAPI#Methods)).
Full documentation is available at http://steamodd.readthedocs.org/en/latest/.


# Testing #
## Testing ##

To launch the test suite run `python setup.py run_tests -k <KEY>`.

[![Build Status](https://travis-ci.org/Lagg/steamodd.png)](https://travis-ci.org/Lagg/steamodd)

# Contributing #

## Contributing ##

If you would like to contribute please send a pull request.

# Bugs and feature requests #

## Bugs and feature requests ##

Feel free to open an [issue](https://github.com/Lagg/steamodd/issues)
if you spot a bug or have an idea you would like to see go into steamodd.
192 changes: 192 additions & 0 deletions docs/Makefile
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,192 @@
# 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 clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext

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)"

clean:
rm -rf $(BUILDDIR)/*

html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."

singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."

pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."

json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."

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."

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/Steamodd.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Steamodd.qhc"

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."

devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/Steamodd"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Steamodd"
@echo "# devhelp"

epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."

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)."

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."

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."

text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."

man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."

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)."

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."

gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."

changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."

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."

doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."

coverage:
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
@echo "Testing of coverage in the sources finished, look at the " \
"results in $(BUILDDIR)/coverage/python.txt."

xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."

pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
Loading

0 comments on commit fc50a38

Please sign in to comment.