Skip to content

Commit 29469e1

Browse files
authored
Ghreport feat1 (#86)
* new features added * filled changelog * Prepare release github-report-v0.1.2
1 parent 0746f5e commit 29469e1

File tree

15 files changed

+325
-246
lines changed

15 files changed

+325
-246
lines changed

.github/workflows/github-report-release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ jobs:
196196
- installs the bundled github-report wheel
197197
- creates the github-report launcher in ~/.local/bin
198198
- verifies the installed version
199-
- explains how to create a GitHub account and token if you do not have one yet
199+
- explains the GitHub token permissions needed for report access
200200
201201
If you want to install directly from the release page without extracting first:
202202

services/github-report/CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,18 @@ All notable changes to this project are tracked here. This changelog follows
1616

1717
## [Unreleased]
1818

19+
## [github-report-v0.1.2] - 2026-03-15
20+
21+
- replace the org-specific CLI flow with a required `--owner` option that works for GitHub organizations and personal accounts
22+
- support activity reports for owner-wide scans and individual public repositories using the same modifications-then-commits ranking
23+
- make the installer idempotent for re-runs and wheel upgrades, and simplify GitHub token guidance for end users
24+
1925
## [github-report-v0.1.1] - 2026-03-15
2026

2127
- improve installer guidance for Python setup, GitHub account/token creation, and post-install verification
2228
- publish installer, tarball, checksums, and install notes as release assets
29+
2330
## [github-report-v0.1.0] - 2026-03-14
2431

2532
- first release
33+

services/github-report/README.md

Lines changed: 37 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# github-report
22

33
`github-report` is a Python CLI that ranks contributors across GitHub
4-
repositories in an organization.
4+
repositories owned by a GitHub organization or personal account.
55

6-
It works with any GitHub organization that your token can access. The default
7-
org is `nebius`.
6+
It works with any GitHub owner that your token can access. `--owner` is
7+
required for every report or listing command.
88

99
It is optimized for executive reporting:
1010

@@ -34,13 +34,13 @@ Word or Google Docs with table formatting preserved.
3434

3535
## Defaults
3636

37-
- organization: `nebius`
37+
- owner: none, must be provided with `--owner`
3838
- report window: relative days, defaulting to `--days 30`
3939
- output format: `markdown`
4040
- ranking: `modifications`
4141
- top rows: `10`
4242
- bots: excluded when GitHub classifies the account type as `Bot`
43-
- repositories: all accessible repos in the organization
43+
- repositories: all accessible repos under the selected owner
4444
- branch scope: repository default branch only
4545

4646
When you omit `--since` and `--all-time`, the CLI uses a relative-days window.
@@ -97,43 +97,42 @@ setting `GITHUB_TOKEN`.
9797

9898
## Usage
9999

100-
Show the top 10 contributors across all accessible repos in the default org
101-
(`nebius`) for the last 30 days:
100+
Show the top 10 contributors across all accessible repos under an organization:
102101

103102
```bash
104-
github-report top-users
103+
github-report top-users --owner nebius
105104
```
106105

107106
The explicit equivalent is:
108107

109108
```bash
110-
github-report top-users --days 30
109+
github-report top-users --owner nebius --days 30
111110
```
112111

113112
Run the same report against another organization:
114113

115114
```bash
116-
github-report --org my-github-org top-users
115+
github-report --owner lm-academy top-users
117116
```
118117

119-
You can also override the organization at the command level:
118+
Run the same report against a personal account:
120119

121120
```bash
122-
github-report top-users --org my-github-org
121+
github-report top-users --owner dashabalashova
123122
```
124123

125124
Show the top 50 contributors since a specific date. This already ranks by
126125
modifications by default:
127126

128127
```bash
129-
github-report top-users --top 50 --since 2026-01-01
128+
github-report top-users --owner nebius --top 50 --since 2026-01-01
130129
```
131130

132131
Use a relative lookback window when you want the last `N` days instead of a
133132
fixed start date:
134133

135134
```bash
136-
github-report top-users --top 50 --days 60
135+
github-report top-users --owner nebius --top 50 --days 60
137136
```
138137

139138
`--days` cannot be combined with `--since`. `--all-time` bypasses both.
@@ -142,39 +141,39 @@ You can combine `--days` with `--until` to anchor that relative window at a
142141
specific end time:
143142

144143
```bash
145-
github-report top-users --top 50 --days 60 --until 2026-03-01
144+
github-report top-users --owner lm-academy --top 50 --days 60 --until 2026-03-01
146145
```
147146

148147
You can also anchor the default `--days 30` window without passing `--days`
149148
explicitly:
150149

151150
```bash
152-
github-report top-users --top 50 --until 2026-03-01
151+
github-report top-users --owner nebius --top 50 --until 2026-03-01
153152
```
154153

155154
Switch back to commit-first ranking when you need it:
156155

157156
```bash
158-
github-report top-users --top 50 --since 2026-01-01 --sort-by commits
157+
github-report top-users --owner nebius --top 50 --since 2026-01-01 --sort-by commits
159158
```
160159

161160
Show contributor rows per repository instead of aggregating across the selected
162161
repos:
163162

164163
```bash
165-
github-report top-users --per-repo --top 50 --since 2026-01-01
164+
github-report top-users --owner dashabalashova --per-repo --top 50 --since 2026-01-01
166165
```
167166

168167
Limit the report to a small repo set:
169168

170169
```bash
171-
github-report top-users --repos pysdk,gosdk,api --since 2026-02-01
170+
github-report top-users --owner nebius --repos pysdk,gosdk,api --since 2026-02-01
172171
```
173172

174-
Exclude specific repositories from an org-wide report:
173+
Exclude specific repositories from an owner-wide report:
175174

176175
```bash
177-
github-report top-users --exclude csa-soperator-deployments,api --since 2026-02-01
176+
github-report top-users --owner nebius --exclude csa-soperator-deployments,api --since 2026-02-01
178177
```
179178

180179
Exclusions are applied after `--repos` and `--repos-file`, so you can start
@@ -183,49 +182,57 @@ with a small include list and still subtract a few repositories.
183182
Load repo filters from a text file:
184183

185184
```bash
186-
github-report top-users --repos-file repos.txt --since 2026-02-01
185+
github-report top-users --owner lm-academy --repos-file repos.txt --since 2026-02-01
186+
```
187+
188+
Limit the report to one repo under an organization or personal account:
189+
190+
```bash
191+
github-report top-users --owner lm-academy --repos github-actions-course --all-time
192+
193+
github-report top-users --owner dashabalashova --repos boltz-benchmark --all-time
187194
```
188195

189196
Write CSV output to a file:
190197

191198
```bash
192-
github-report top-users --per-repo --format csv --output report.csv --all-time
199+
github-report top-users --owner nebius --per-repo --format csv --output report.csv --all-time
193200
```
194201

195202
Write Markdown output without passing `--format` explicitly:
196203

197204
```bash
198-
github-report top-users --output report.md
205+
github-report top-users --owner nebius --output report.md
199206
```
200207

201208
Write plain text output for easier copy/paste into Slack or editors:
202209

203210
```bash
204-
github-report top-users --output report.txt
211+
github-report top-users --owner nebius --output report.txt
205212
```
206213

207214
Write HTML output for easier copy/paste into Word:
208215

209216
```bash
210-
github-report top-users --output report.html
217+
github-report top-users --owner nebius --output report.html
211218
```
212219

213220
List accessible repositories before building a filter file:
214221

215222
```bash
216-
github-report list-repos
223+
github-report list-repos --owner nebius
217224
```
218225

219-
List repositories in another organization:
226+
List repositories for a personal account:
220227

221228
```bash
222-
github-report list-repos --org my-github-org
229+
github-report list-repos --owner dashabalashova
223230
```
224231

225232
## Repo Filter File
226233

227234
`--repos-file` accepts one repo per line. Short names are resolved against the
228-
selected org.
235+
selected owner.
229236

230237
```text
231238
# comments are allowed

0 commit comments

Comments
 (0)