From f3517dcb993faf25a940f8c8990590cc0459a9a4 Mon Sep 17 00:00:00 2001 From: Thor77 Date: Wed, 8 Jun 2016 22:10:15 +0200 Subject: [PATCH] add quickstart-guide to docs and placeholders for config and cli * bump version to 0.6.4 --- docs/source/cli.rst | 2 ++ docs/source/conf.py | 2 +- docs/source/config.rst | 2 ++ docs/source/index.rst | 8 +++++++- docs/source/quickstart.rst | 30 ++++++++++++++++++++++++++++++ setup.py | 2 +- 6 files changed, 43 insertions(+), 3 deletions(-) create mode 100644 docs/source/cli.rst create mode 100644 docs/source/config.rst create mode 100644 docs/source/quickstart.rst diff --git a/docs/source/cli.rst b/docs/source/cli.rst new file mode 100644 index 0000000..23ca889 --- /dev/null +++ b/docs/source/cli.rst @@ -0,0 +1,2 @@ +Command-Line-Interface +********************** diff --git a/docs/source/conf.py b/docs/source/conf.py index 9e89c9b..888ab03 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -56,7 +56,7 @@ author = 'Thor77' # The short X.Y version. version = '0.6' # The full version, including alpha/beta/rc tags. -release = '0.6.3' +release = '0.6.4' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/source/config.rst b/docs/source/config.rst new file mode 100644 index 0000000..edebed0 --- /dev/null +++ b/docs/source/config.rst @@ -0,0 +1,2 @@ +Config +****** diff --git a/docs/source/index.rst b/docs/source/index.rst index df077dc..a02465b 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,10 +1,16 @@ Welcome to TeamspeakStats's documentation! ========================================== +This document contains a more in-depth and technical documentation (in contrast to the `README `_) +for TeamspeakStats. + Contents: .. toctree:: :maxdepth: 2 - api + quickstart + cli + config identmap + api diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst new file mode 100644 index 0000000..e165771 --- /dev/null +++ b/docs/source/quickstart.rst @@ -0,0 +1,30 @@ +Quickstart +********** +First, you have to get and install a decent version of `Python `_ (at least 2.7). +Now you have various options to use TeamspeakStats, going from easy to hard: + +1. Install the tool via pip ``pip install tsstats`` +2. Clone the sourcecode ``git clone https://github.com/Thor77/TeamspeakStats`` + + * **A** Just run the script from your local copy ``python -m tsstats`` + * **B** Install the script with the included *setup.py* ``python setup.py install`` + +To start, you can just use cli-arguments to control the behaviour of TeamspeakStats:: + + usage: tsstats [-h] [-c CONFIG] [--idmap IDMAP] [-l LOG] [-o OUTPUT] [-d] + + A simple Teamspeak stats-generator - based on server-logs + + optional arguments: + -h, --help show this help message and exit + -c CONFIG, --config CONFIG + path to config + --idmap IDMAP path to id_map + -l LOG, --log LOG path to your logfile(s) + -o OUTPUT, --output OUTPUT + path to the output-file + -d, --debug debug mode + +Take a look at :doc:`cli` to get a more in-depth explanation of the available flags. +If you want to use TeamspeakStats in a script (or cron) you should consider creating +a :doc:`config`. diff --git a/setup.py b/setup.py index 36bd5f3..ea11b67 100644 --- a/setup.py +++ b/setup.py @@ -2,7 +2,7 @@ from setuptools import setup setup( name='tsstats', - version='0.6.3', + version='0.6.4', author='Thor77', author_email='thor77@thor77.org', description='A simple Teamspeak stats-generator',