{"id":20262138,"url":"https://github.com/kefir500/ghstats","last_synced_at":"2025-04-11T01:51:06.856Z","repository":{"id":57434249,"uuid":"43163884","full_name":"kefir500/ghstats","owner":"kefir500","description":"Python script to obtain GitHub Release download count and other statistics.","archived":false,"fork":false,"pushed_at":"2021-07-22T09:54:29.000Z","size":48,"stargazers_count":34,"open_issues_count":0,"forks_count":4,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-24T23:06:02.940Z","etag":null,"topics":["github","github-releases","python","python-script"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kefir500.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-09-25T17:21:01.000Z","updated_at":"2024-08-26T11:58:45.000Z","dependencies_parsed_at":"2022-08-27T21:11:43.313Z","dependency_job_id":null,"html_url":"https://github.com/kefir500/ghstats","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kefir500%2Fghstats","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kefir500%2Fghstats/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kefir500%2Fghstats/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kefir500%2Fghstats/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kefir500","download_url":"https://codeload.github.com/kefir500/ghstats/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247947858,"owners_count":21023066,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github","github-releases","python","python-script"],"created_at":"2024-11-14T11:28:40.489Z","updated_at":"2025-04-11T01:51:06.835Z","avatar_url":"https://github.com/kefir500.png","language":"Python","readme":"GitHub Download Stats\n=====================\n\n|Build Status|\n|Code Quality|\n|Coverage|\n|Version|\n|Support|\n|License|\n\nDescription\n-----------\n\n- Python script to obtain GitHub Release download count and other statistics.\n- Can be used as both a standalone script and a Python module.\n\nInstallation\n------------\n\nYou can get ``ghstats`` using **one of the following** methods:\n\n- Install from `PyPI`_: ``pip install ghstats``.\n- Save `ghstats.py`_ from the repository.\n- Download a whole `repository`_.\n\nUsage\n-----\n\n::\n\n    ghstats [user] [repo] [tag] [options]\n    ghstats [user/repo] [tag] [options]\n\n- *Arguments:*\n\n======== =======================================================================\nArgument Description\n======== =======================================================================\n``user`` Repository owner. If not present, user will be prompted for input.\n``repo`` Repository title. If not present, user will be prompted for input.\n``tag``  Release tag name. If not present, prints the total number of downloads.\n======== =======================================================================\n\n- *Options:*\n\n==================== ==================================================================\nOption               Description\n==================== ==================================================================\n``-d``, ``--detail`` Print detailed statistics for release(s).\n``-q``, ``--quiet``  Print only resulting numbers and errors. Overrides ``-d`` option.\n``-l``, ``--latest`` Get stats for the latest release. ``Tag`` argument will be ignored.\n``-h``, ``--help``   Show help on script usage.\n==================== ==================================================================\n\n- *Environment Variables:*\n\n==================== ===================================================================\nEnvironment Variable Description\n==================== ===================================================================\n``GITHUB_TOKEN``     `GitHub personal access token`_. Use to increase API request limit.\n==================== ===================================================================\n\nExamples\n--------\n\nExamples for `atom/atom`_ repository:\n\n.. code:: shell\n\n    ghstats atom atom            # Fetch download count for all releases.\n    ghstats atom/atom            # Fetch download count for all releases (alt. syntax).\n    ghstats atom atom -q         # Quiet mode (print only numerical result).\n    ghstats atom atom -d         # Detailed description for every release.\n    ghstats atom atom -l         # Fetch download count for the latest release.\n    ghstats atom atom -l -d      # Detailed description for the latest release.\n    ghstats atom atom -l -q      # Quiet mode for the latest release.\n    ghstats atom atom v1.0.0     # Fetch download count for \"v1.0.0\" release.\n    ghstats atom atom v1.0.0 -d  # Detailed description for \"v1.0.0\" release.\n    ghstats atom atom v1.0.0 -q  # Quiet mode for \"v1.0.0\" release.\n    ghstats                      # Get input for username and repository from user.\n    ghstats -h                   # Print help.\n\nChangelog\n---------\n\n**v2.0.0**\n\n- Add support for GitHub API pagination.\n- Drop support for Python 2.\n\n**v1.2.0**\n\n- Fix error on empty release title (`issue #5`_).\n\n**v1.1.1**\n\n- First `PyPI`_ release (`issue #3`_).\n\n**v1.1.0**\n\n- Fix error on Unicode titles (`issue #1`_).\n- Fix error on draft release (`issue #4`_).\n\n**v1.0.1**\n\n- Redesigned exceptions (`issue #2`_).\n\n**v1.0.0**\n\n- Initial release.\n\nLicense\n-------\n\n**MIT License**\n\nYou are free to use, modify, distribute (including commercial purposes)\nas long as you credit the original author and include the license text.\n\nLicense text: `MIT License`_\n\n.. _ghstats.py: https://raw.githubusercontent.com/kefir500/ghstats/master/ghstats/ghstats.py\n.. _PyPI: https://pypi.python.org/pypi/ghstats\n.. _repository: https://github.com/kefir500/ghstats/archive/master.zip\n.. _atom/atom: https://github.com/atom/atom\n.. _GitHub personal access token: https://github.com/settings/tokens\n.. _issue #1: https://github.com/kefir500/ghstats/issues/1\n.. _issue #2: https://github.com/kefir500/ghstats/issues/2\n.. _issue #3: https://github.com/kefir500/ghstats/issues/3\n.. _issue #4: https://github.com/kefir500/ghstats/issues/4\n.. _issue #5: https://github.com/kefir500/ghstats/issues/5\n.. _MIT License: https://raw.githubusercontent.com/kefir500/ghstats/master/LICENSE\n\n.. |Build Status| image:: https://travis-ci.org/kefir500/ghstats.svg\n   :target: https://travis-ci.org/kefir500/ghstats\n.. |Code Quality| image:: https://img.shields.io/codacy/grade/f79a8e1ad6764ae4ba420f063e3bac90.svg\n   :target: https://app.codacy.com/app/kefir500/ghstats/dashboard\n.. |Coverage| image:: https://coveralls.io/repos/github/kefir500/ghstats/badge.svg?branch=master\n   :target: https://coveralls.io/github/kefir500/ghstats?branch=master\n.. |Version| image:: https://img.shields.io/pypi/v/ghstats.svg\n   :target: https://pypi.python.org/pypi/ghstats\n.. |Support| image:: https://img.shields.io/pypi/pyversions/ghstats.svg\n   :target: https://pypi.python.org/pypi/ghstats\n.. |License| image:: https://img.shields.io/badge/license-MIT-blue.svg\n   :target: https://raw.githubusercontent.com/kefir500/ghstats/master/LICENSE\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkefir500%2Fghstats","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkefir500%2Fghstats","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkefir500%2Fghstats/lists"}