Metadata-Version: 2.1
Name: service-stats
Version: 1.2.0
Summary: Service serves savvy server stats.
Home-page: http://github.com/justintime50/service
Author: Justintime50
License: MIT
Description: <div align="center">
        
        # Service
        
        Service serves savvy server stats.
        
        [![Build Status](https://travis-ci.com/Justintime50/service.svg?branch=master)](https://travis-ci.com/Justintime50/service)
        [![Coverage Status](https://coveralls.io/repos/github/Justintime50/service/badge.svg?branch=master)](https://coveralls.io/github/Justintime50/service?branch=master)
        [![PyPi](https://img.shields.io/pypi/v/service-stats)](https://pypi.org/project/service-stats/)
        [![Licence](https://img.shields.io/github/license/justintime50/service)](LICENSE)
        
        <img src="assets/showcase.png" alt="Showcase">
        
        </div>
        
        Service is completely configurable, allowing you to request data about boot time, CPU usage, disk usage, memory usage, network usage, and system information. You can send all this right to Slack. Great for a daily/weekly server snapshot of what's going on. Build custom logic to warn you about high CPU/memory usage or low available disk space.
        
        ## Install
        
        ```bash
        # Install Service
        pip3 install service-stats
        
        # Install locally
        make install
        
        # Setup Slack ENV variables (optional)
        cp .env.example .env
        
        # Get Makefile help
        make help
        ```
        
        ## Usage
        
        Grab all server data and send it to Slack.
        
        ```
        Usage:
            service --boot --cpu --disk --memory --network --system --slack
        
        Options:
            -h, --help     show this help message and exit
            -b, --boot     Show boot time stats.
            -c, --cpu      Show CPU stats.
            -d, --disk     Show disk stats.
            -m, --memory   Show memory stats.
            -n, --network  Show network stats.
            -s, --system   Show system stats.
            -sl, --slack   Send Service report to Slack.
        
        Environment Variables (optional):
            SLACK_BOT_TOKEN     The Slackbot token to use for authentication
            SLACK_CHANNEL       The channel to post a message to
        ```
        
        ## Cron
        
        ```bash
        crontab -e
        
        0 9 * * 1 service --boot --cpu --disk --memory --network --system --slack
        ```
        
        ## Development
        
        ```bash
        # Lint the project
        make lint
        
        # Run tests
        make test
        
        # Run the scripts locally
        venv/bin/python service/app.py --help
        ```
        
        ## Attribution
        
        Based on [this article](https://www.thepythoncode.com/article/get-hardware-system-information-python).
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: dev
