{ "info": { "author": "Alexander Gorishnyak", "author_email": "kefir500@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Topic :: Utilities" ], "description": "GitHub Download Stats\r\n=====================\r\n\r\n|Build Status|\r\n|Code Quality|\r\n|Coverage|\r\n|Version|\r\n|Support|\r\n|License|\r\n\r\nDescription\r\n-----------\r\n\r\n- Python script to obtain GitHub Release download count and other statistics.\r\n- Can be used as both a standalone script and a Python module.\r\n- Supports both Python 2 and 3 out of the box.\r\n\r\nInstallation\r\n------------\r\n\r\nYou can get ``ghstats`` using **one of the following** methods:\r\n\r\n- Install from `PyPI`_: ``pip install ghstats``.\r\n- Save `ghstats.py`_ from the repository.\r\n- Download a whole `repository`_.\r\n\r\nUsage\r\n-----\r\n\r\n::\r\n\r\n ghstats [user] [repo] [tag] [options]\r\n ghstats [user/repo] [tag] [options]\r\n\r\n- *Arguments:*\r\n\r\n======== =======================================================================\r\nArgument Description\r\n======== =======================================================================\r\n``user`` Repository owner. If not present, user will be prompted for input.\r\n``repo`` Repository title. If not present, user will be prompted for input.\r\n``tag`` Release tag name. If not present, prints the total number of downloads.\r\n======== =======================================================================\r\n\r\n- *Options:*\r\n\r\n==================== ==================================================================\r\nOption Description\r\n==================== ==================================================================\r\n``-d``, ``--detail`` Print detailed statistics for release(s).\r\n``-q``, ``--quiet`` Print only resulting numbers and errors. Overrides ``-d`` option.\r\n``-l``, ``--latest`` Get stats for the latest release. ``Tag`` argument will be ignored.\r\n``-h``, ``--help`` Show help on script usage.\r\n==================== ==================================================================\r\n\r\n- *Environment Variables:*\r\n\r\n==================== =========================================================\r\nEnvironment Variable Description\r\n==================== =========================================================\r\n``GITHUB_TOKEN`` `GitHub OAuth token`_. Use to increase API request limit.\r\n==================== =========================================================\r\n\r\nExamples\r\n--------\r\n\r\nExamples for `atom/atom`_ repository:\r\n\r\n.. code:: shell\r\n\r\n ghstats atom atom # Fetch download count for all releases.\r\n ghstats atom/atom # Fetch download count for all releases (alt. syntax).\r\n ghstats atom atom -q # Quiet mode (print only numerical result).\r\n ghstats atom atom -d # Detailed description for every release.\r\n ghstats atom atom -l # Fetch download count for the latest release.\r\n ghstats atom atom -l -d # Detailed description for the latest release.\r\n ghstats atom atom -l -q # Quiet mode for the latest release.\r\n ghstats atom atom v1.0.0 # Fetch download count for \"v1.0.0\" release.\r\n ghstats atom atom v1.0.0 -d # Detailed description for \"v1.0.0\" release.\r\n ghstats atom atom v1.0.0 -q # Quiet mode for \"v1.0.0\" release.\r\n ghstats # Get input for username and repository from user.\r\n ghstats -h # Print help.\r\n\r\nChangelog\r\n---------\r\n\r\n**v1.2.0**\r\n\r\n- Fix error on empty release title (`issue #5`_).\r\n\r\n**v1.1.1**\r\n\r\n- First `PyPI`_ release (`issue #3`_).\r\n\r\n**v1.1.0**\r\n\r\n- Fix error on Unicode titles (`issue #1`_).\r\n- Fix error on draft release (`issue #4`_).\r\n\r\n**v1.0.1**\r\n\r\n- Redesigned exceptions (`issue #2`_).\r\n\r\n**v1.0.0**\r\n\r\n- Initial release.\r\n\r\nLicense\r\n-------\r\n\r\n**MIT License**\r\n\r\nYou are free to use, modify, distribute (including commercial purposes)\r\nas long as you credit the original author and include the license text.\r\n\r\nLicense text: `MIT License`_\r\n\r\n.. _ghstats.py: https://raw.githubusercontent.com/kefir500/ghstats/master/ghstats/ghstats.py\r\n.. _PyPI: https://pypi.python.org/pypi/ghstats\r\n.. _repository: https://github.com/kefir500/ghstats/archive/master.zip\r\n.. _atom/atom: https://github.com/atom/atom\r\n.. _GitHub OAuth token: https://github.com/settings/tokens\r\n.. _issue #1: https://github.com/kefir500/ghstats/issues/1\r\n.. _issue #2: https://github.com/kefir500/ghstats/issues/2\r\n.. _issue #3: https://github.com/kefir500/ghstats/issues/3\r\n.. _issue #4: https://github.com/kefir500/ghstats/issues/4\r\n.. _issue #5: https://github.com/kefir500/ghstats/issues/5\r\n.. _MIT License: https://raw.githubusercontent.com/kefir500/ghstats/master/LICENSE\r\n\r\n.. |Build Status| image:: https://travis-ci.org/kefir500/ghstats.svg\r\n :target: https://travis-ci.org/kefir500/ghstats\r\n.. |Code Quality| image:: https://img.shields.io/codacy/grade/f79a8e1ad6764ae4ba420f063e3bac90.svg\r\n :target: https://app.codacy.com/app/kefir500/ghstats/dashboard\r\n.. |Coverage| image:: https://coveralls.io/repos/github/kefir500/ghstats/badge.svg?branch=master\r\n :target: https://coveralls.io/github/kefir500/ghstats?branch=master\r\n.. |Version| image:: https://img.shields.io/pypi/v/ghstats.svg\r\n :target: https://pypi.python.org/pypi/ghstats\r\n.. |Support| image:: https://img.shields.io/pypi/pyversions/ghstats.svg\r\n :target: https://pypi.python.org/pypi/ghstats\r\n.. |License| image:: https://img.shields.io/badge/license-MIT-blue.svg\r\n :target: https://raw.githubusercontent.com/kefir500/ghstats/master/LICENSE\r\n\r\n\r\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/kefir500/ghstats", "keywords": "github release download count stats statistics", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "ghstats", "package_url": "https://pypi.org/project/ghstats/", "platform": "", "project_url": "https://pypi.org/project/ghstats/", "project_urls": { "Homepage": "https://github.com/kefir500/ghstats" }, "release_url": "https://pypi.org/project/ghstats/1.2.0/", "requires_dist": null, "requires_python": "", "summary": "GitHub Release download count and other statistics.", "version": "1.2.0" }, "last_serial": 3840530, "releases": { "1.1.1": [ { "comment_text": "", "digests": { "md5": "c7c91944ee787b019fd1ff0d99b0fcd2", "sha256": "48932c776c6826fb7394c881348d063fcd3ed226738fb11503ee757ff70d7c94" }, "downloads": -1, "filename": "ghstats-1.1.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "c7c91944ee787b019fd1ff0d99b0fcd2", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 9063, "upload_time": "2016-09-27T08:19:14", "url": "https://files.pythonhosted.org/packages/f2/ff/787c308a64089137675d7e6c6faa183db89d4587f465f4f31a9ffd023f66/ghstats-1.1.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c9a225235b5866d2c6257f7a8120cd53", "sha256": "961c3c4e8a9faf2af5739234e302c99b027ec083ea9e226e874e5955f3c506ae" }, "downloads": -1, "filename": "ghstats-1.1.1.tar.gz", "has_sig": false, "md5_digest": "c9a225235b5866d2c6257f7a8120cd53", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6159, "upload_time": "2016-09-27T08:19:16", "url": "https://files.pythonhosted.org/packages/c5/33/21b51f2914cbad67bdeb3a081319a3dbc2d830e5185afc3cb3b1995682ae/ghstats-1.1.1.tar.gz" } ], "1.2.0": [ { "comment_text": "", "digests": { "md5": "a179674b3512df020d6cb0146c1b17dc", "sha256": "e6aced3e5718f80ee8002e4d5492c439a318e0610485adf363306a8d524a0c75" }, "downloads": -1, "filename": "ghstats-1.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "a179674b3512df020d6cb0146c1b17dc", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 6841, "upload_time": "2018-05-07T10:22:40", "url": "https://files.pythonhosted.org/packages/ab/27/89a763bdabc6e3e29b7308031d673114eadbba34156313e0809fdab8fa4c/ghstats-1.2.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4e7f3548215dcc8f9814139001965bd1", "sha256": "5e8fce99fb75303ecda9cd602b103efb5bfd8e9867f81938e217b65ef5077fd7" }, "downloads": -1, "filename": "ghstats-1.2.0.tar.gz", "has_sig": false, "md5_digest": "4e7f3548215dcc8f9814139001965bd1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6304, "upload_time": "2018-05-07T10:22:41", "url": "https://files.pythonhosted.org/packages/48/0e/40ea0eda01a2959d7cf01c51f104cd35b5fad431a85d844baea8cdb30d8f/ghstats-1.2.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "a179674b3512df020d6cb0146c1b17dc", "sha256": "e6aced3e5718f80ee8002e4d5492c439a318e0610485adf363306a8d524a0c75" }, "downloads": -1, "filename": "ghstats-1.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "a179674b3512df020d6cb0146c1b17dc", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 6841, "upload_time": "2018-05-07T10:22:40", "url": "https://files.pythonhosted.org/packages/ab/27/89a763bdabc6e3e29b7308031d673114eadbba34156313e0809fdab8fa4c/ghstats-1.2.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4e7f3548215dcc8f9814139001965bd1", "sha256": "5e8fce99fb75303ecda9cd602b103efb5bfd8e9867f81938e217b65ef5077fd7" }, "downloads": -1, "filename": "ghstats-1.2.0.tar.gz", "has_sig": false, "md5_digest": "4e7f3548215dcc8f9814139001965bd1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6304, "upload_time": "2018-05-07T10:22:41", "url": "https://files.pythonhosted.org/packages/48/0e/40ea0eda01a2959d7cf01c51f104cd35b5fad431a85d844baea8cdb30d8f/ghstats-1.2.0.tar.gz" } ] }