Metadata-Version: 1.1
Name: ghstats
Version: 1.2.0
Summary: GitHub Release download count and other statistics.
Home-page: https://github.com/kefir500/ghstats
Author: Alexander Gorishnyak
Author-email: kefir500@gmail.com
License: MIT
Description: GitHub Download Stats
        =====================
        
        |Build Status|
        |Code Quality|
        |Coverage|
        |Version|
        |Support|
        |License|
        
        Description
        -----------
        
        - Python script to obtain GitHub Release download count and other statistics.
        - Can be used as both a standalone script and a Python module.
        - Supports both Python 2 and 3 out of the box.
        
        Installation
        ------------
        
        You can get ``ghstats`` using **one of the following** methods:
        
        - Install from `PyPI`_: ``pip install ghstats``.
        - Save `ghstats.py`_ from the repository.
        - Download a whole `repository`_.
        
        Usage
        -----
        
        ::
        
            ghstats [user] [repo] [tag] [options]
            ghstats [user/repo] [tag] [options]
        
        - *Arguments:*
        
        ======== =======================================================================
        Argument Description
        ======== =======================================================================
        ``user`` Repository owner. If not present, user will be prompted for input.
        ``repo`` Repository title. If not present, user will be prompted for input.
        ``tag``  Release tag name. If not present, prints the total number of downloads.
        ======== =======================================================================
        
        - *Options:*
        
        ==================== ==================================================================
        Option               Description
        ==================== ==================================================================
        ``-d``, ``--detail`` Print detailed statistics for release(s).
        ``-q``, ``--quiet``  Print only resulting numbers and errors. Overrides ``-d`` option.
        ``-l``, ``--latest`` Get stats for the latest release. ``Tag`` argument will be ignored.
        ``-h``, ``--help``   Show help on script usage.
        ==================== ==================================================================
        
        - *Environment Variables:*
        
        ==================== =========================================================
        Environment Variable Description
        ==================== =========================================================
        ``GITHUB_TOKEN``     `GitHub OAuth token`_. Use to increase API request limit.
        ==================== =========================================================
        
        Examples
        --------
        
        Examples for `atom/atom`_ repository:
        
        .. code:: shell
        
            ghstats atom atom            # Fetch download count for all releases.
            ghstats atom/atom            # Fetch download count for all releases (alt. syntax).
            ghstats atom atom -q         # Quiet mode (print only numerical result).
            ghstats atom atom -d         # Detailed description for every release.
            ghstats atom atom -l         # Fetch download count for the latest release.
            ghstats atom atom -l -d      # Detailed description for the latest release.
            ghstats atom atom -l -q      # Quiet mode for the latest release.
            ghstats atom atom v1.0.0     # Fetch download count for "v1.0.0" release.
            ghstats atom atom v1.0.0 -d  # Detailed description for "v1.0.0" release.
            ghstats atom atom v1.0.0 -q  # Quiet mode for "v1.0.0" release.
            ghstats                      # Get input for username and repository from user.
            ghstats -h                   # Print help.
        
        Changelog
        ---------
        
        **v1.2.0**
        
        - Fix error on empty release title (`issue #5`_).
        
        **v1.1.1**
        
        - First `PyPI`_ release (`issue #3`_).
        
        **v1.1.0**
        
        - Fix error on Unicode titles (`issue #1`_).
        - Fix error on draft release (`issue #4`_).
        
        **v1.0.1**
        
        - Redesigned exceptions (`issue #2`_).
        
        **v1.0.0**
        
        - Initial release.
        
        License
        -------
        
        **MIT License**
        
        You are free to use, modify, distribute (including commercial purposes)
        as long as you credit the original author and include the license text.
        
        License text: `MIT License`_
        
        .. _ghstats.py: https://raw.githubusercontent.com/kefir500/ghstats/master/ghstats/ghstats.py
        .. _PyPI: https://pypi.python.org/pypi/ghstats
        .. _repository: https://github.com/kefir500/ghstats/archive/master.zip
        .. _atom/atom: https://github.com/atom/atom
        .. _GitHub OAuth token: https://github.com/settings/tokens
        .. _issue #1: https://github.com/kefir500/ghstats/issues/1
        .. _issue #2: https://github.com/kefir500/ghstats/issues/2
        .. _issue #3: https://github.com/kefir500/ghstats/issues/3
        .. _issue #4: https://github.com/kefir500/ghstats/issues/4
        .. _issue #5: https://github.com/kefir500/ghstats/issues/5
        .. _MIT License: https://raw.githubusercontent.com/kefir500/ghstats/master/LICENSE
        
        .. |Build Status| image:: https://travis-ci.org/kefir500/ghstats.svg
           :target: https://travis-ci.org/kefir500/ghstats
        .. |Code Quality| image:: https://img.shields.io/codacy/grade/f79a8e1ad6764ae4ba420f063e3bac90.svg
           :target: https://app.codacy.com/app/kefir500/ghstats/dashboard
        .. |Coverage| image:: https://coveralls.io/repos/github/kefir500/ghstats/badge.svg?branch=master
           :target: https://coveralls.io/github/kefir500/ghstats?branch=master
        .. |Version| image:: https://img.shields.io/pypi/v/ghstats.svg
           :target: https://pypi.python.org/pypi/ghstats
        .. |Support| image:: https://img.shields.io/pypi/pyversions/ghstats.svg
           :target: https://pypi.python.org/pypi/ghstats
        .. |License| image:: https://img.shields.io/badge/license-MIT-blue.svg
           :target: https://raw.githubusercontent.com/kefir500/ghstats/master/LICENSE
        
Keywords: github release download count stats statistics
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Utilities
