├── tests ├── __init__.py ├── test_github.py └── test_utils.py ├── pr_duration ├── __init__.py ├── __main__.py └── cli.py ├── .gitignore ├── pyproject.toml ├── setup.py ├── README.md ├── .github └── workflows │ └── check.yml └── LICENSE /tests/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /pr_duration/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /pr_duration/__main__.py: -------------------------------------------------------------------------------- 1 | from .cli import cli 2 | 3 | if __name__ == "__main__": 4 | cli() 5 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .venv 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | venv 6 | .eggs 7 | .pytest_cache 8 | *.egg-info 9 | .DS_Store 10 | build 11 | .ruff_cache 12 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [tool.black] 2 | line-length = 120 3 | 4 | [tool.isort] 5 | profile = "black" 6 | 7 | [tool.ruff] 8 | # Enable Pyflakes and pycodestyle rules. 9 | select = ["E", "F"] 10 | line-length=120 11 | 12 | [tool.bandit] 13 | exclude_dirs = ["venv", "build", "pr_duration.egg.info", ".pytest_cache"] 14 | -------------------------------------------------------------------------------- /tests/test_github.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | 3 | import click 4 | 5 | from pr_duration.cli import get_closed_pull_requests 6 | 7 | 8 | class GithubPullRequestsTestCase(unittest.TestCase): 9 | def test_get_prs(self): 10 | results = get_closed_pull_requests("django/django", token=None, max_prs=101) 11 | self.assertEqual(len(results), 200) 12 | 13 | def test_private_repo(self): 14 | with self.assertRaises(click.Abort): 15 | get_closed_pull_requests("sesh/private", token=None, max_prs=100) 16 | -------------------------------------------------------------------------------- /tests/test_utils.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | 3 | from pr_duration.cli import pretty_time_delta 4 | 5 | 6 | class TimedeltaFormatTestCase(unittest.TestCase): 7 | def test_simple_timedelta(self): 8 | result = pretty_time_delta(12203) 9 | self.assertEqual(result, "3h23m23s") 10 | 11 | def test_short_timedelta(self): 12 | result = pretty_time_delta(12) 13 | self.assertEqual(result, "12s") 14 | 15 | def test_long_timedelta(self): 16 | result = pretty_time_delta(400 * 24 * 60 * 60) 17 | self.assertEqual(result, "400d0h0m0s") 18 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | import os 2 | 3 | from setuptools import setup 4 | 5 | VERSION = "0.1" 6 | 7 | 8 | def get_long_description(): 9 | with open( 10 | os.path.join(os.path.dirname(os.path.abspath(__file__)), "README.md"), 11 | encoding="utf8", 12 | ) as fp: 13 | return fp.read() 14 | 15 | 16 | setup( 17 | name="pr-duration", 18 | description="PR Open -> PR Merged", 19 | long_description=get_long_description(), 20 | long_description_content_type="text/markdown", 21 | url="https://github.com/sesh/pr-duration", 22 | project_urls={ 23 | "Issues": "https://github.com/sesh/pr-duration/issues", 24 | "CI": "https://github.com/sesh/pr-duration/actions", 25 | "Changelog": "https://github.com/sesh/pr-duration/releases", 26 | }, 27 | license="Apache License, Version 2.0", 28 | version=VERSION, 29 | packages=["pr_duration"], 30 | entry_points=""" 31 | [console_scripts] 32 | pr-duration=pr_duration.cli:cli 33 | """, 34 | install_requires=["click", "thttp"], 35 | extras_require={"test": ["coverage"]}, 36 | python_requires=">=3.7", 37 | ) 38 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # pr-duration 2 | 3 | Check in on how long it takes your Pull Requests to go from Open -> Merged. 4 | 5 | ## Installation 6 | 7 | Install this tool using `pip`: 8 | 9 | pip install git+https://github.com/sesh/pr-duration.git 10 | 11 | ## Usage 12 | 13 | By default the tool will output the average and median duration that PRs merged in the last 30 days were open for. 14 | Provide the `--repo` argument to output the average duration for a single repo: 15 | 16 | pr-duration --token= --repo=sesh/pr-duration 17 | 18 | Use `--token` with a Github token that has the correct access if you are checking a private repo: 19 | 20 | pr-duration --token= --repo=sesh/private 21 | 22 | For help and details of other options, run: 23 | 24 | pr-duration --help 25 | 26 | You can also use: 27 | 28 | python -m pr_duration --help 29 | 30 | 31 | ## Development 32 | 33 | To contribute to this tool, first checkout the code. Then create a new virtual environment: 34 | 35 | cd pr-duration 36 | python -m venv venv 37 | source venv/bin/activate 38 | 39 | Now install the dependencies and test dependencies: 40 | 41 | pip install -e '.[test]' 42 | -------------------------------------------------------------------------------- /.github/workflows/check.yml: -------------------------------------------------------------------------------- 1 | name: Python Checks 2 | 3 | on: 4 | push: 5 | branches: [ main ] 6 | pull_request: 7 | branches: [ main ] 8 | workflow_dispatch: 9 | 10 | jobs: 11 | test: 12 | runs-on: ubuntu-latest 13 | strategy: 14 | matrix: 15 | python-version: ["3.8", "3.9", "3.10", "3.11"] 16 | 17 | steps: 18 | - uses: actions/checkout@v3 19 | 20 | - name: Set up Python ${{ matrix.python-version }} 21 | uses: actions/setup-python@v4 22 | with: 23 | python-version: ${{ matrix.python-version }} 24 | 25 | - name: Install test dependencies 26 | run: | 27 | pip install -e '.[test]' 28 | 29 | - name: Test with unittest 30 | run: | 31 | python -m unittest discover 32 | 33 | black: 34 | runs-on: ubuntu-latest 35 | 36 | steps: 37 | - uses: actions/checkout@v3 38 | 39 | - name: Set up Python 40 | uses: actions/setup-python@v4 41 | with: 42 | python-version: "3.11" 43 | 44 | - name: Install black 45 | run: | 46 | python -m pip install black 47 | 48 | - name: Run black 49 | run: | 50 | black --check . 51 | 52 | isort: 53 | runs-on: ubuntu-latest 54 | 55 | steps: 56 | - uses: actions/checkout@v3 57 | 58 | - name: Set up Python 59 | uses: actions/setup-python@v4 60 | with: 61 | python-version: "3.11" 62 | 63 | - name: Install isort 64 | run: | 65 | python -m pip install isort 66 | 67 | - name: Run isort 68 | run: | 69 | isort --check . 70 | 71 | ruff: 72 | runs-on: ubuntu-latest 73 | 74 | steps: 75 | - uses: actions/checkout@v3 76 | 77 | - name: Set up Python 78 | uses: actions/setup-python@v4 79 | with: 80 | python-version: "3.11" 81 | 82 | - name: Install ruff 83 | run: | 84 | python -m pip install ruff 85 | 86 | - name: Run ruff 87 | run: | 88 | ruff --format=github . 89 | 90 | bandit: 91 | runs-on: ubuntu-latest 92 | 93 | steps: 94 | - uses: actions/checkout@v3 95 | 96 | - name: Set up Python 97 | uses: actions/setup-python@v4 98 | with: 99 | python-version: 3 100 | 101 | - name: Install bandit 102 | run: | 103 | python -m pip install bandit[toml] 104 | 105 | - name: Run bandit scan 106 | run: | 107 | bandit -c pyproject.toml -r . 108 | -------------------------------------------------------------------------------- /pr_duration/cli.py: -------------------------------------------------------------------------------- 1 | from datetime import datetime, timedelta, timezone 2 | 3 | import click 4 | from thttp import request 5 | 6 | 7 | class PR: 8 | def __init__(self, j): 9 | self._json = j 10 | 11 | def author(self): 12 | return self._json["user"]["login"] 13 | 14 | def open_duration(self): 15 | if self._json["merged_at"]: 16 | return ( 17 | datetime.fromisoformat(self._json["merged_at"]) - datetime.fromisoformat(self._json["created_at"]) 18 | ).total_seconds() 19 | 20 | def is_merged(self): 21 | return self._json["merged_at"] is not None 22 | 23 | def merged_ago(self): 24 | """number of days since this was merged""" 25 | if self._json["merged_at"]: 26 | return ( 27 | datetime.utcnow().replace(tzinfo=timezone.utc) - datetime.fromisoformat(self._json["merged_at"]) 28 | ).days 29 | 30 | def merged_at(self): 31 | if self._json["merged_at"]: 32 | return datetime.fromisoformat(self._json["merged_at"]) 33 | 34 | 35 | def pretty_time_delta(seconds): 36 | # https://gist.github.com/thatalextaylor/7408395 37 | seconds = int(seconds) 38 | days, seconds = divmod(seconds, 86400) 39 | hours, seconds = divmod(seconds, 3600) 40 | minutes, seconds = divmod(seconds, 60) 41 | if days > 0: 42 | return "%dd%dh%dm%ds" % (days, hours, minutes, seconds) 43 | elif hours > 0: 44 | return "%dh%dm%ds" % (hours, minutes, seconds) 45 | elif minutes > 0: 46 | return "%dm%ds" % (minutes, seconds) 47 | else: 48 | return "%ds" % (seconds,) 49 | 50 | 51 | def get_closed_pull_requests(repo, token, *, max_prs=500): 52 | print("Max PRs:", max_prs) 53 | prs = [] 54 | page = 1 55 | 56 | headers = { 57 | "Accept": "application/vnd.github+json", 58 | } 59 | 60 | if token: 61 | headers["Authorization"] = f"Bearer {token}" 62 | 63 | while page: 64 | click.echo(f"Requesting page {page} of PRs from Github ({repo})") 65 | 66 | response = request( 67 | f"https://api.github.com/repos/{repo}/pulls", 68 | headers=headers, 69 | params={ 70 | "state": "closed", 71 | "per_page": "100", 72 | "page": page, 73 | }, 74 | ) 75 | 76 | if response.status == 200 and response.json: 77 | for pr in response.json: 78 | prs.append(PR(pr)) 79 | 80 | page += 1 81 | 82 | if len(prs) >= max_prs: 83 | return prs 84 | elif response.status == 404: 85 | click.echo(f"Received 404 from Github for {repo}. Check your token if this is a private repository.") 86 | raise click.Abort() 87 | else: 88 | click.echo(f"Receivied {response.status} from Github for {repo}. Returning PRs that we have so far.") 89 | return prs 90 | 91 | return prs 92 | 93 | 94 | @click.group(invoke_without_command=True) 95 | @click.option("--token", help="Github token with repo access (required for private repositories)") 96 | @click.option("--repo", help="Github repository in / format", required=True) 97 | @click.option( 98 | "--max-age", 99 | help="Maximum age of PRs to include in the average, age in days based on merged_at", 100 | default=30, 101 | ) 102 | @click.option("--excluded-authors", help="Comma separated list of authors to exclude") 103 | @click.option("--authors", help="Comma separated list of authors to include") 104 | @click.option("--max-prs", help="The maximum number of PRs to request from Github", default=500) 105 | @click.pass_context 106 | def cli(ctx, token, repo, max_age, excluded_authors, authors, max_prs): 107 | prs = get_closed_pull_requests(repo, token, max_prs=max_prs) 108 | 109 | click.echo(f"Collected {len(prs)} pull requests from Github") 110 | 111 | # filter: merged 112 | prs = [pr for pr in prs if pr.is_merged()] 113 | click.echo(f"Filtered to {len(prs)} that have been merged") 114 | 115 | # filter: max age 116 | prs = [pr for pr in prs if pr.merged_ago() < max_age] 117 | click.echo(f"Filtered to {len(prs)} that were merged in the last {max_age} days") 118 | 119 | # filter: excluded authors 120 | if excluded_authors: 121 | excluded_authors = [a.strip().lower() for a in excluded_authors.split(",")] 122 | prs = [pr for pr in prs if pr.author().lower() not in excluded_authors] 123 | click.echo(f"Filtered to {len(prs)} that were not authored by {excluded_authors}") 124 | 125 | # filter: included authors 126 | if authors: 127 | authors = [a.strip().lower() for a in authors.split(",")] 128 | prs = [pr for pr in prs if pr.author().lower() in authors] 129 | click.echo(f"Filtered to {len(prs)} that were authored by {authors}") 130 | 131 | if len(prs) == 0: 132 | click.echo(f"No PRs left for {repo}.") 133 | raise click.Abort() 134 | 135 | ctx.ensure_object(dict) 136 | ctx.obj["prs"] = prs 137 | 138 | if ctx.invoked_subcommand is None: 139 | # average time to merge = sum(open_duration) / len(prs) 140 | total_seconds = sum([pr.open_duration() for pr in prs]) 141 | click.echo(f"Average time to merge: {pretty_time_delta(total_seconds / len(prs))}") 142 | 143 | # median time to merge = the middle PR 144 | prs = sorted(prs, key=lambda pr: pr.open_duration()) 145 | [pr.open_duration() for pr in prs] 146 | click.echo(f"Median time to merge: {pretty_time_delta(prs[int(len(prs) / 2)].open_duration())}") 147 | 148 | 149 | @cli.command(name="graph") 150 | @click.pass_context 151 | def graph(ctx): 152 | prs = ctx.obj["prs"] 153 | now = datetime.utcnow().replace(tzinfo=timezone.utc, hour=0, minute=0, second=0, microsecond=0) + timedelta(days=1) 154 | 155 | stats_range = 150 # todo: rename / arg 156 | start = now - timedelta(days=stats_range) # todo: rename / arg 157 | window_days = 14 # todo: rename / arg 158 | 159 | # todo: ensure that max-age < start date - window_days 160 | 161 | while start < now: 162 | in_range = [pr for pr in prs if pr.merged_at() < start and pr.merged_at() > start - timedelta(days=window_days)] 163 | 164 | if in_range: 165 | total_seconds = sum([pr.open_duration() for pr in in_range]) 166 | avg_dur = total_seconds / len(in_range) 167 | else: 168 | avg_dur = 0 169 | 170 | print(f"{start}\t{len(in_range)}\t{int(avg_dur)}\t{pretty_time_delta(avg_dur)}\t{avg_dur / 60 / 60 / 24}") 171 | start = start + timedelta(days=1) 172 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------