Claytonia/TeamspeakStats
Claytonia
/
TeamspeakStats
mirror of https://github.com/Thor77/TeamspeakStats.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
A simple Teamspeak stats-generator - based on server-logs https://claytonia.net/tsstats.html
380 Commits 6 Branches 44 Tags 646 KiB
Python 89.7%
Jinja 10.3%
Go to file
Thor77 ef5894b407 Refactor documentation 
* move documentation-source from /docs/source to /docs/ and build in
/docs/_build instead of /docs/build
* convert README to rst and remove information also present in
documentation and refer to it
* regenerate conf.py/Makefile with most recent Sphinx-version
* add development.rst with information for contributors
 		2017-04-19 23:24:30 +02:00
docs Refactor documentation 2017-04-19 23:24:30 +02:00
tsstats Remove unnecessary variable-declaration 2017-03-31 22:39:57 +02:00
.coveragerc Exclude tsstats/logger.py from coverage-report 2017-02-27 13:37:05 +01:00
.gitignore Refactor documentation 2017-04-19 23:24:30 +02:00
.travis.yml Use flake8 instead of pyflakes 2017-02-19 17:14:49 +01:00
LICENSE Bump LICENSE-year to 2017 2017-02-11 22:15:51 +01:00
README.rst Refactor documentation 2017-04-19 23:24:30 +02:00
requirements.txt update {testing_,}requirement-versions 2016-05-08 18:00:17 +02:00
screenshot.png Update screenshot.png 2017-02-11 22:21:58 +01:00
setup.py Bump version to 1.4.1 2017-03-30 20:15:09 +02:00
testing_requirements.txt use py.test instead of nose for testing 2016-05-09 20:09:16 +02:00

README.rst 

TeamspeakStats |Build Status| |Build status| |Coverage Status| |Code Health| |PyPI| |Documentation Status|
==========================================================================================================

A simple Teamspeak stat-generator - based solely on server-logs

|screenshot|

Installation
============

-  Install the package via PyPi ``pip install tsstats``
-  Clone this repo
   ``git clone https://github.com/Thor77/TeamspeakStats`` and install
   with ``python setup.py install``
-  Just use the package as is via ``python -m tsstats [-h]``

Usage
=====

-  Run the script ``tsstats [-h]``
-  Optionally create a config-file (see
   `Configuration <https://teamspeakstats.readthedocs.io/en/latest/config.html>`__)
-  The package works entirely off your Teamspeak server's logs, so that
   no ServerQuery account is necessary

Example
=======

::

    tsstats -l /var/log/teamspeak3-server/ts3server*.log -o /var/www/tsstats.html

Parse logs matching ``ts3server*.log`` in ``/var/log/teamspeak3-server``
and write output to ``/var/www/tsstats.html``.

For more details checkout the `documentation <http://teamspeakstats.readthedocs.io/en/latest/>`__!

.. |screenshot| image:: https://raw.githubusercontent.com/Thor77/TeamspeakStats/master/screenshot.png
.. |Build Status| image:: https://travis-ci.org/Thor77/TeamspeakStats.svg?branch=master
   :target: https://travis-ci.org/Thor77/TeamspeakStats
.. |Build status| image:: https://ci.appveyor.com/api/projects/status/u9cx7krwmmevbvl2?svg=true
   :target: https://ci.appveyor.com/project/Thor77/teamspeakstats
.. |Coverage Status| image:: https://coveralls.io/repos/Thor77/TeamspeakStats/badge.svg?branch=master&service=github
   :target: https://coveralls.io/github/Thor77/TeamspeakStats?branch=master
.. |Code Health| image:: https://landscape.io/github/Thor77/TeamspeakStats/master/landscape.svg?style=flat
   :target: https://landscape.io/github/Thor77/TeamspeakStats/master
.. |PyPI| image:: https://img.shields.io/pypi/v/tsstats.svg
   :target: https://pypi.python.org/pypi/tsstats
.. |Documentation Status| image:: https://readthedocs.org/projects/teamspeakstats/badge/?version=latest
   :target: http://teamspeakstats.readthedocs.io/en/latest/?badge=latest