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
296 Commits 6 Branches 44 Tags 646 KiB
Python 89.7%
Jinja 10.3%
Go to file
Thor77 9c09f34f02 Update template-location for package_data 2016-11-18 21:55:33 +01:00
docs Import Config-table from README into docs 2016-11-01 22:14:15 +01:00
tsstats Rename default template to stats.jinja2 2016-11-18 21:52:30 +01:00
.coveragerc remove test_general.py (testing __main__) to get clear coverage-results 2016-05-19 21:40:37 +02:00
.gitignore add .gitignore 2016-05-08 20:46:15 +02:00
.travis.yml limit pyflakes and isort-check to tsstats-package 2016-05-18 21:35:06 +02:00
LICENSE Update copyright-year and add copyright-holder 2016-09-30 22:23:07 +02:00
README.md Add onlinetimethreshold to Configuration-section 2016-11-14 21:28:02 +01:00
requirements.txt update {testing_,}requirement-versions 2016-05-08 18:00:17 +02:00
screenshot.png Update screenshot to showcase last-connected-hint 2016-10-28 23:33:14 +02:00
setup.py Update template-location for package_data 2016-11-18 21:55:33 +01:00
testing_requirements.txt use py.test instead of nose for testing 2016-05-09 20:09:16 +02:00

README.md

TeamspeakStats Build Status Coverage Status Code Health PyPI Documentation Status

A simple Teamspeak stat-generator - based 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)

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

CLI-Usage

usage: tsstats [-h] [-c CONFIG] [--idmap IDMAP] [-l LOG] [-o OUTPUT] [-d]
                   [-nod]

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
  -nod, --noonlinedc    don't add connect until now to onlinetime
  -t TEMPLATE, --template TEMPLATE
                        path to custom template
  -dtf DATETIMEFORMAT, --datetimeformat DATETIMEFORMAT
                        format of date/time-values (datetime.strftime)
  -otth ONLINETIMETHRESHOLD, --onlinetimethreshold ONLINETIMETHRESHOLD
                        threshold for displaying onlinetime (in seconds)

Configuration

[General]

Key Description
log Path to TS3Server-logfile(s) (supports globbing)
output Path to the location, where the generator will put the generated .html-file
idmap Path to IdentMap
debug debug mode
onlinedc Add timedelta from last-connect until now to onlinetime for connected clients
template Path to a custom template file (relative from tsstats/ or absolute)
datetimeformat Format of date/time-values used for render-timestamp and last online (using datetime.strftime)
onlinetimethreshold Clients with an onlinetime below that threshold (in seconds) are hidden in the onlinetime-section

Example

[General]
log = /usr/local/bin/teamspeak-server/logs/ts3server*_1.log
output = /var/www/html/stats.html

Contributing

Please make sure tests are succeeding and your code follows flake8-guidelines.

Run tests

  • Install testing-requirements pip install -r testing_requirements.txt
  • Run py.test tsstats/

TODO

  • Localization