Metadata-Version: 2.1
Name: statshog
Version: 1.0.6
Summary: A simple statsd client.
Home-page: https://github.com/macobo/statshog
Author: Karl-Aksel Puulmann
Author-email: karl@technicalwealth.ee
License: MIT
Description: A Python statsd client
        ======================
        
        A python client for [Etsy](<http://etsy.com>)'s
        [StatsD](<https://github.com/etsy/statsd>) server and
        [InfluxDB's](<http://influxdb.com>)
        [Telegraf](<https://github.com/influxdb/telegraf>) StatsD server.
        
        [![Latest release](https://img.shields.io/pypi/v/statshog.svg)](https://pypi.python.org/pypi/statshog/)
        
        [![Supported Python versions](https://img.shields.io/pypi/pyversions/statshog.svg)](https://pypi.python.org/pypi/statshog/)
        
        [![Wheel Status](https://img.shields.io/pypi/wheel/statshog.svg)](https://pypi.python.org/pypi/statshog/)
        
        Code:   <https://github.com/macobo/statshog>
        
        License:   MIT; see LICENSE file
        
        Issues:   <https://github.com/macobo/statshog/issues>
        
        Documentation:   <https://statshog.readthedocs.io/>
        
        
        
        # Install
        
        The easiest way to install statsd is with pip!
        
        You can install from PyPI:
        
        ```bash
        pip install statshog
        ```
        
        Or GitHub:
        
        ```bash
        $ pip install -e git+https://github.com/macobo/statshog#egg=statshog
        ```
        
        Or from source:
        
        ```bash
        git clone https://github.com/macobo/statshog
        cd pystatsd
        python setup.py install
        ```
        
        # Usage
        
        ## Quick usage
        
        ```python
        import statshog
        statsd = statshog.StatsClient(host='localhost', port=8125)
        statsd.incr('foo')  # Increment the 'foo' counter.
        statsd.timing('stats.timed', 320)  # Record a 320ms 'stats.timed'
        ```
        
        ## Using with telegraf/influxdb
        
        ```python
        import statshog
        statsd = statshog.StatsClient(telegraf=True)
        statsd.timing('stats.timed', 320, tags={"mytag": 456})
        ```
        
        ## Usage with django
        
        Update your settings.py to have the following values if using non-defaults:
        - `STATSD_HOST` (default: `'localhost'`)
        - `STATSD_PORT` (default: `8125`)
        - `STATSD_PREFIX` (default: `None`)
        - `STATSD_MAXUDPSIZE` (default: `512`)
        - `STATSD_IPV6` (default: `False`)
        - `STATSD_TELEGRAF` (default: `False`)
        - `STATSD_SEPARATOR` (default: `'.'`)
        
        Then, you can use statshog as following:
        
        ```python
        from statshog.defaults.django import statsd
        
        statsd.timing('stats.timed', 320)
        ```
        
        To use together with
        [django-statsd](<https://github.com/django-statsd/django-statsd>), also add
        the following to your `settings.py`:
        
        ```python
        STATSD_CLIENT = "statshog"
        ```
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
