pr-stats


Namepr-stats JSON
Version 0.0.3 PyPI version JSON
download
home_pagehttps://github.com/AmitHasanShuvo/PR-stats
SummaryThis module brings different stats about pull requests using GitHub API.
upload_time2023-01-06 09:55:15
maintainer
docs_urlNone
authorKazi Amit Hasan
requires_python
license
keywords stats pull requests github
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
# PR-stats
![Author](https://img.shields.io/badge/author-AmitHasanShuvo-orange)
[![MIT](https://img.shields.io/badge/license-MIT-5eba00.svg)](https://github.com/AmitHasanShuvo/data-inspector/blob/main/LICENCE.txt)
[![Contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/AmitHasanShuvo/PR-stats)
[![Stars](https://img.shields.io/github/stars/AmitHasanShuvo/PR-stats.svg?style=social)](https://github.com/AmitHasanShuvo/PR-stats/stargazers)


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:
  ```bibtex
@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

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/AmitHasanShuvo/PR-stats",
    "name": "pr-stats",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "stats,pull requests,github",
    "author": "Kazi Amit Hasan",
    "author_email": "kaziamithasan89@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/e1/04/e492a12750426a8c547cd3a0a66905157c0ae275564f8e6889caedeeee77/pr_stats-0.0.3.tar.gz",
    "platform": null,
    "description": "\n# PR-stats\n![Author](https://img.shields.io/badge/author-AmitHasanShuvo-orange)\n[![MIT](https://img.shields.io/badge/license-MIT-5eba00.svg)](https://github.com/AmitHasanShuvo/data-inspector/blob/main/LICENCE.txt)\n[![Contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/AmitHasanShuvo/PR-stats)\n[![Stars](https://img.shields.io/github/stars/AmitHasanShuvo/PR-stats.svg?style=social)](https://github.com/AmitHasanShuvo/PR-stats/stargazers)\n\n\nPR-stats is an open-source python library that brings different functions to bring stats about pull requests.\n\n## Author: Kazi Amit Hasan\n\n## How to get your personal GitHub access token\nYou can follow the instructions from listed link to obtain such a token.\nLink: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token\n## Project Description: \n\nPR stats brings different statistics about pull requests. \n\n\n## Installation:\n\n```pip install pr-stats```\n\nPackage available at https://pypi.org/project/pr-stats/\n\n\n### How to use:\n\nAll stats about pull requests: ``` get_pull_requests(\"ownername\", \"reponame\", \"your_token\") ```\n\n#### Available features:\n1. id\n2. title\n3. state\n4. created_at\n5. updated_at\n6. closed_at\n7. lifetime_minutes\n8. first_comment_time\n9. first_response_time\n10. user_login\n11. user_name\n12. user_avatar_url\n13. head_ref\n14. head_sha\n15. head_repo_name\n16. base_ref\n17. base_sha\n18. base_repo_name\n19. merged_at\n20. reviewers\n\n\n\n### How to cite:\n  ```bibtex\n@online{PR-stats,\n  title={PR-stats},\n  url={https://pypi.org/project/pr-stats/},\n  urldate = {2023-01-06}, \n  publisher={Kazi Amit Hasan}\n}\n```\n\n### Future Works:\n1. Add some more automations.\n\n### How to contribute:\nAny contribution would be highly appreciated. Kindly go through the guidelines for contributing in github.\n\n\n\n\nChange Log\n==========\n\n0.0.1 (6/1/2023)\n------------------\n- First Release\n\n0.0.2 (6/1/2023)\n------------------\n- instructions added\n\n\n0.0.3 (6/1/2023)\n------------------\n- instructions added and typos fixed\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "This module brings different stats about pull requests using GitHub API.",
    "version": "0.0.3",
    "split_keywords": [
        "stats",
        "pull requests",
        "github"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e5d3f539b2f4548a324dc7cbc4b5cbd54ebaf2b6ceb35850b00f7352728f9695",
                "md5": "ddf805972b0fdc875f9df9397055509e",
                "sha256": "95450ec70be7a466c81ffc0817501c8bb692a1fc026267055edad151e0ccb687"
            },
            "downloads": -1,
            "filename": "pr_stats-0.0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ddf805972b0fdc875f9df9397055509e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 3559,
            "upload_time": "2023-01-06T09:55:13",
            "upload_time_iso_8601": "2023-01-06T09:55:13.860666Z",
            "url": "https://files.pythonhosted.org/packages/e5/d3/f539b2f4548a324dc7cbc4b5cbd54ebaf2b6ceb35850b00f7352728f9695/pr_stats-0.0.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e104e492a12750426a8c547cd3a0a66905157c0ae275564f8e6889caedeeee77",
                "md5": "affb942fc4bad7c1125cfa362c4dcbc7",
                "sha256": "f250c859a354016e2e4a6f043e78a0d38a505bec4c8153b6ad39f093d219b7ca"
            },
            "downloads": -1,
            "filename": "pr_stats-0.0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "affb942fc4bad7c1125cfa362c4dcbc7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 3442,
            "upload_time": "2023-01-06T09:55:15",
            "upload_time_iso_8601": "2023-01-06T09:55:15.494706Z",
            "url": "https://files.pythonhosted.org/packages/e1/04/e492a12750426a8c547cd3a0a66905157c0ae275564f8e6889caedeeee77/pr_stats-0.0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-01-06 09:55:15",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "AmitHasanShuvo",
    "github_project": "PR-stats",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "pr-stats"
}
        
Elapsed time: 0.02559s