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
443 Commits 6 Branches 44 Tags 646 KiB
Python 89.7%
Jinja 10.3%
Go to file
Thor77 1ef4a3bc15 Handle connected clients on unexpected shutdown 
caused, for example, by a server crash.
Could be triggered by an incorrectly named logfile as well because it is
assumed once there are connected clients in a logfile which isn't the
last one to be parsed.

The fix is realized by taking the timestamp of the last event from the
currently parsed logfile and disconnecting all still connected clients
on that timestamp.
 		2018-05-19 17:28:03 +02:00
docs Refactor documentation 2017-04-19 23:24:30 +02:00
tsstats Handle connected clients on unexpected shutdown 2018-05-19 17:28:03 +02:00
.coveragerc Exclude tsstats/logger.py from coverage-report 2017-02-27 13:37:05 +01:00
.gitignore Add pytests .cache to .gitignore 2018-02-01 17:02:56 +01:00
.travis.yml Use pylama for stylechecks 2018-02-01 21:49:02 +01:00
LICENSE Bump LICENSE-year to 2017 2017-02-11 22:15:51 +01:00
Pipfile Add Pipfile 2018-03-02 23:59:21 +01:00
Pipfile.lock Add Pipfile 2018-03-02 23:59:21 +01:00
README.rst Limit build status on AppVeyor to master-branch 2018-01-30 19:14:51 +01:00
requirements.txt Use pendulum instead of plain datetime 2017-07-07 14:22:24 +02:00
screenshot.png Update screenshot.png 2017-02-11 22:21:58 +01:00
setup.py Bump version to 2.0.0 2018-01-19 22:28:28 +01:00
testing_requirements.txt Add pendulum to testing_requirements.txt 2017-08-03 23:39:50 +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/ -o /var/www/tsstats.html

Parse logs 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/branch/master?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