Skip to main content

This module brings different stats about pull requests using GitHub API.

Project description

PR-stats

Author MIT Contributions welcome Stars

PR-stats is an open-source python library that brings different functions to bring stats about pull requests.

Author: Kazi Amit Hasan

How to get your personal GitHub access token

You can follow the instructions from listed link to obtain such a token. Link: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token

Project Description:

PR stats brings different statistics about pull requests.

Installation:

pip install pr-stats

Package available at https://pypi.org/project/pr-stats/

How to use:

All stats about pull requests: get_pull_requests("ownername", "reponame", "your_token")

Available features:

  1. id
  2. title
  3. state
  4. created_at
  5. updated_at
  6. closed_at
  7. lifetime_minutes
  8. first_comment_time
  9. first_response_time
  10. user_login
  11. user_name
  12. user_avatar_url
  13. head_ref
  14. head_sha
  15. head_repo_name
  16. base_ref
  17. base_sha
  18. base_repo_name
  19. merged_at
  20. reviewers

How to cite:

@online{PR-stats,
title={PR-stats},
url={https://pypi.org/project/pr-stats/},
urldate = {2023-01-06}, 
publisher={Kazi Amit Hasan}
}

Future Works:

  1. Add some more automations.

How to contribute:

Any contribution would be highly appreciated. Kindly go through the guidelines for contributing in github.

Change Log

0.0.1 (6/1/2023)

  • First Release

0.0.2 (6/1/2023)

  • instructions added

0.0.3 (6/1/2023)

  • instructions added and typos fixed

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pr_stats-0.0.3.tar.gz (3.4 kB view hashes)

Uploaded Source

Built Distribution

pr_stats-0.0.3-py3-none-any.whl (3.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page