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
478 Commits 6 Branches 44 Tags 646 KiB
Python 89.7%
Jinja 10.3%
Go to file
snyk-bot 74b8835798
fix: requirements.txt to reduce vulnerabilities 
The following vulnerabilities are fixed by pinning transitive dependencies:
- https://snyk.io/vuln/SNYK-PYTHON-JINJA2-1012994
 		2021-02-02 01:02:23 +00:00
docs Remove testing-requirements.txt (replaced by -dev) 2019-03-10 13:10:09 +01:00
tsstats Disable shadows on hints 2020-03-27 22:39:50 +01: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 Drop testing for Python 2 2020-03-27 22:52:34 +01:00
LICENSE Bump LICENSE-year to 2017 2017-02-11 22:15:51 +01:00
Pipfile Update dependencies 2019-03-10 12:58:36 +01:00
Pipfile.lock Update dependencies 2020-03-27 22:47:03 +01:00
README.rst Remove landscape badge completely 2020-03-27 22:55:51 +01:00
requirements-dev.txt Update dependencies 2020-03-27 22:47:03 +01:00
requirements.txt fix: requirements.txt to reduce vulnerabilities 2021-02-02 01:02:23 +00:00
screenshot.png Update screenshot.png 2017-02-11 22:21:58 +01:00
setup.py Bump version to 2.0.1 2018-05-19 18:10:30 +02:00

README.rst 

TeamspeakStats |Build Status| |Build status| |Coverage Status| |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
.. |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