github-dependents-info 1.6.2__tar.gz → 2.0.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- github_dependents_info-1.6.2/README.md → github_dependents_info-2.0.0/PKG-INFO +70 -21
- github_dependents_info-1.6.2/PKG-INFO → github_dependents_info-2.0.0/README.md +42 -51
- {github_dependents_info-1.6.2 → github_dependents_info-2.0.0}/github_dependents_info/__main__.py +16 -2
- github_dependents_info-2.0.0/github_dependents_info/gh_dependents_info.py +791 -0
- {github_dependents_info-1.6.2 → github_dependents_info-2.0.0}/pyproject.toml +34 -41
- github_dependents_info-1.6.2/github_dependents_info/gh_dependents_info.py +0 -482
- github_dependents_info-1.6.2/setup.py +0 -39
- {github_dependents_info-1.6.2 → github_dependents_info-2.0.0}/LICENSE +0 -0
- {github_dependents_info-1.6.2 → github_dependents_info-2.0.0}/github_dependents_info/__init__.py +0 -0
|
@@ -1,3 +1,30 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: github-dependents-info
|
|
3
|
+
Version: 2.0.0
|
|
4
|
+
Summary: Collect information about dependencies between a github repo and other repositories. Results available in JSON, markdown and badges.
|
|
5
|
+
License-Expression: MIT
|
|
6
|
+
License-File: LICENSE
|
|
7
|
+
Keywords: github,dependent,used-by,repository,stats,dependencies,using
|
|
8
|
+
Author: nvuillam
|
|
9
|
+
Author-email: nicolas.vuillamy@gmail.com
|
|
10
|
+
Requires-Python: >=3.10,<4.0
|
|
11
|
+
Classifier: Development Status :: 3 - Alpha
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: Operating System :: OS Independent
|
|
14
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
15
|
+
Classifier: Programming Language :: Python :: 3
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
17
|
+
Requires-Dist: beautifulsoup4 (==4.14.3)
|
|
18
|
+
Requires-Dist: click (>=8.3.1,<8.4)
|
|
19
|
+
Requires-Dist: httpx (>=0.28.1,<0.29.0)
|
|
20
|
+
Requires-Dist: idna (>=3.11)
|
|
21
|
+
Requires-Dist: pandas (>=2.3.3,<3.0)
|
|
22
|
+
Requires-Dist: rich (>=14.2,<14.3)
|
|
23
|
+
Requires-Dist: typer[all] (>=0.20,<0.21)
|
|
24
|
+
Project-URL: Homepage, https://github.com/nvuillam/github-dependents-info
|
|
25
|
+
Project-URL: Repository, https://github.com/nvuillam/github-dependents-info
|
|
26
|
+
Description-Content-Type: text/markdown
|
|
27
|
+
|
|
1
28
|
# github-dependents-info
|
|
2
29
|
|
|
3
30
|
<div align="center">
|
|
@@ -10,7 +37,7 @@
|
|
|
10
37
|
[](https://github.com/nvuillam/github-dependents-info/pulls?utf8=%E2%9C%93&q=is%3Apr%20author%3Aapp%2Fdependabot)
|
|
11
38
|
|
|
12
39
|
[](https://github.com/nvuillam/github-dependents-info/graphs/contributors/)<!-- gh-dependents-info-used-by-start -->
|
|
13
|
-
[](https://github.com/nvuillam/github-dependents-info/blob/main/docs/github-dependents-info.md)<!-- gh-dependents-info-used-by-end -->
|
|
14
41
|
[](https://github.com/sponsors/nvuillam)
|
|
15
42
|
[](https://github.com/nvuillam/github-dependents-info/actions/workflows/mega-linter.yml)
|
|
16
43
|
[](https://github.com/nvuillam/github-dependents-info/blob/master/LICENSE)
|
|
@@ -35,9 +62,11 @@ This package uses GitHub HTML to collect dependents information and can:
|
|
|
35
62
|
- Generate summary markdown file
|
|
36
63
|
- Update existing markdown by inserting **Used by** badge within tags
|
|
37
64
|
- `<!-- gh-dependents-info-used-by-start -->
|
|
38
|
-
[](https://github.com/nvuillam/github-dependents-info/blob/main/docs/github-dependents-info.md)<!-- gh-dependents-info-used-by-end -->`
|
|
39
66
|
- Handle multiple repositories packages
|
|
40
|
-
- Filter results using minimum stars
|
|
67
|
+
- Filter results using minimum stars or by repository owner
|
|
68
|
+
- Keep huge ecosystems manageable with pagination controls (`--max-scraped-pages`, `--pagination/--no-pagination`, `--page-size`)
|
|
69
|
+
- Fetch dependents faster thanks to asynchronous `httpx` requests and parallelized page scraping
|
|
41
70
|
|
|
42
71
|
|
|
43
72
|
Badges example
|
|
@@ -234,19 +263,30 @@ _________________
|
|
|
234
263
|
github-dependents-info [OPTIONS]
|
|
235
264
|
```
|
|
236
265
|
|
|
237
|
-
| Parameter
|
|
238
|
-
|
|
239
|
-
| --repo
|
|
240
|
-
| -b<br/> --badgemarkdownfile
|
|
241
|
-
|
|
242
|
-
| -
|
|
243
|
-
| -
|
|
244
|
-
| -
|
|
245
|
-
| -
|
|
246
|
-
| -
|
|
247
|
-
| -
|
|
248
|
-
| -
|
|
249
|
-
| --
|
|
266
|
+
| Parameter | Type | Description |
|
|
267
|
+
|-----------------------------------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
268
|
+
| --repo | String | Repository. Example: `oxsecurity/megalinter` |
|
|
269
|
+
| -b<br/> --badgemarkdownfile | String | _(optional)_ Path to markdown file where to insert/update **Used by** badge <br/> (must contain tags `<!-- gh-dependents-info-used-by-start -->` … `<!-- gh-dependents-info-used-by-end -->`) |
|
|
270
|
+
| -s<br/> --sort | String | _(optional)_ Sort order: name (default) or stars |
|
|
271
|
+
| -x<br/> --minstars | String | _(optional)_ If set, filters repositories to keep only those with more than X stars |
|
|
272
|
+
| -m<br/> --markdownfile | String | _(optional)_ Output markdown file file |
|
|
273
|
+
| -d<br/> --docurl | String | _(optional)_ Hyperlink to use when clicking on badge markdown file badge. (Default: link to markdown file) |
|
|
274
|
+
| -p<br/> --mergepackages | String | _(optional)_ In case of multiple packages, merge their stats in a single one in markdown and json output |
|
|
275
|
+
| -j<br/> --json | String | _(optional)_ Output in json format |
|
|
276
|
+
| -u<br/> --owner | String | _(optional)_ If set, filters repositories to keep only those owned by the specified user/organization |
|
|
277
|
+
| -n<br/> --max-scraped-pages | Integer | _(optional)_ Maximum number of GitHub pages to scrape per package (0 uses all available pages) |
|
|
278
|
+
| --pagination<br/> --no-pagination | Boolean | _(optional)_ Enable (default) or disable pagination when writing markdown output |
|
|
279
|
+
| --page-size | Integer | _(optional)_ Number of repositories per markdown page when pagination is enabled (default: 500) |
|
|
280
|
+
| -v<br/> --version | Boolean | _(optional)_ Displays version of github-dependents-info |
|
|
281
|
+
| --verbose | Boolean | _(optional)_ Verbose output |
|
|
282
|
+
|
|
283
|
+
Badge tags example (the tool replaces everything between the markers):
|
|
284
|
+
|
|
285
|
+
```markdown
|
|
286
|
+
<!-- gh-dependents-info-used-by-start -->
|
|
287
|
+
[](https://github.com/nvuillam/github-dependents-info/blob/main/docs/github-dependents-info.md)
|
|
288
|
+
<!-- gh-dependents-info-used-by-end -->
|
|
289
|
+
```
|
|
250
290
|
|
|
251
291
|
_________________
|
|
252
292
|
## 🧪 Examples
|
|
@@ -260,7 +300,7 @@ _________________
|
|
|
260
300
|
github-dependents-info --repo nvuillam/npm-groovy-lint --json
|
|
261
301
|
|
|
262
302
|
- Insert/Update **Used by** markdown badge within an existing markdown file containing tags `<!-- gh-dependents-info-used-by-start -->
|
|
263
|
-
[](https://github.com/nvuillam/github-dependents-info/blob/main/docs/github-dependents-info.md)<!-- gh-dependents-info-used-by-end -->`
|
|
264
304
|
|
|
265
305
|
github-dependents-info --repo nvuillam/npm-groovy-lint --badgemarkdownfile ./README.md
|
|
266
306
|
|
|
@@ -280,6 +320,14 @@ _________________
|
|
|
280
320
|
|
|
281
321
|
github-dependents-info --repo oxsecurity/megalinter --markdownfile ./docs/package-usage.md --sort stars --mergepackages --verbose
|
|
282
322
|
|
|
323
|
+
- Limit scraping to repositories owned by a specific organization and cap pagination to 5 pages per package
|
|
324
|
+
|
|
325
|
+
github-dependents-info --repo oxsecurity/megalinter --owner oxsecurity --max-scraped-pages 5 --verbose
|
|
326
|
+
|
|
327
|
+
- Generate paginated markdown with 250 repositories per page (use `--no-pagination` to force a single file)
|
|
328
|
+
|
|
329
|
+
github-dependents-info --repo nvuillam/npm-groovy-lint --markdownfile ./docs/package-usage.md --page-size 250 --mergepackages
|
|
330
|
+
|
|
283
331
|
## Use as GitHub Action
|
|
284
332
|
|
|
285
333
|
Allow GitHub Actions to create Pull Requests in **Settings > Actions > General**
|
|
@@ -291,7 +339,7 @@ Create a file **.github/workflows/github-dependents-info.yml** in your repositor
|
|
|
291
339
|
If will generate a new Pull Request (or replace the pending one) every time the usage stats will have changed :)
|
|
292
340
|
|
|
293
341
|
Don't forget to add tags `<!-- gh-dependents-info-used-by-start -->
|
|
294
|
-
[](https://github.com/nvuillam/github-dependents-info/blob/main/docs/github-dependents-info.md)<!-- gh-dependents-info-used-by-end -->` in your **README.md**, at the end of another badge line if you want github-dependents-info to replace its content automatically.
|
|
295
343
|
|
|
296
344
|
```yaml
|
|
297
345
|
# GitHub Dependents Info workflow
|
|
@@ -325,14 +373,14 @@ jobs:
|
|
|
325
373
|
steps:
|
|
326
374
|
# Git Checkout
|
|
327
375
|
- name: Checkout Code
|
|
328
|
-
uses: actions/checkout@
|
|
376
|
+
uses: actions/checkout@v6
|
|
329
377
|
with:
|
|
330
378
|
token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
|
|
331
379
|
fetch-depth: 0
|
|
332
380
|
|
|
333
381
|
# Collect data & generate markdown
|
|
334
382
|
- name: GitHub Dependents Info
|
|
335
|
-
uses: nvuillam/github-dependents-info@v1.
|
|
383
|
+
uses: nvuillam/github-dependents-info@v1.6.3 # If you want to always have the latest version, you can use nvuillam/github-dependents-info@main :)
|
|
336
384
|
# See documentation for variables details: https://github.com/nvuillam/github-dependents-info?tab=readme-ov-file#%EF%B8%8F-usage
|
|
337
385
|
with:
|
|
338
386
|
repo: ${{ github.repository }}
|
|
@@ -351,7 +399,7 @@ jobs:
|
|
|
351
399
|
# Create pull request
|
|
352
400
|
- name: Create Pull Request
|
|
353
401
|
id: cpr
|
|
354
|
-
uses: peter-evans/create-pull-request@
|
|
402
|
+
uses: peter-evans/create-pull-request@v8
|
|
355
403
|
with:
|
|
356
404
|
token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
|
|
357
405
|
branch: github-dependents-info-auto-update
|
|
@@ -382,3 +430,4 @@ This package has been inspired by stackexchange post [How to use GitHub API to g
|
|
|
382
430
|
- [Mo Ganji](https://www.linkedin.com/in/mohganji/) <!-- markdown-link-check-disable-line -->
|
|
383
431
|
|
|
384
432
|
This project was generated with [`python-package-template`](https://github.com/TezRomacH/python-package-template)
|
|
433
|
+
|
|
@@ -1,32 +1,3 @@
|
|
|
1
|
-
Metadata-Version: 2.1
|
|
2
|
-
Name: github-dependents-info
|
|
3
|
-
Version: 1.6.2
|
|
4
|
-
Summary: Collect information about dependencies between a github repo and other repositories. Results available in JSON, markdown and badges.
|
|
5
|
-
Home-page: https://github.com/nvuillam/github-dependents-info
|
|
6
|
-
License: MIT
|
|
7
|
-
Keywords: github,dependent,used-by,repository,stats,dependencies,using
|
|
8
|
-
Author: nvuillam
|
|
9
|
-
Author-email: nicolas.vuillamy@gmail.com
|
|
10
|
-
Requires-Python: >=3.9,<4.0
|
|
11
|
-
Classifier: Development Status :: 3 - Alpha
|
|
12
|
-
Classifier: Intended Audience :: Developers
|
|
13
|
-
Classifier: License :: OSI Approved :: MIT License
|
|
14
|
-
Classifier: Operating System :: OS Independent
|
|
15
|
-
Classifier: Programming Language :: Python :: 3
|
|
16
|
-
Classifier: Programming Language :: Python :: 3.9
|
|
17
|
-
Classifier: Programming Language :: Python :: 3.10
|
|
18
|
-
Classifier: Programming Language :: Python :: 3.11
|
|
19
|
-
Classifier: Programming Language :: Python :: 3
|
|
20
|
-
Classifier: Programming Language :: Python :: 3.9
|
|
21
|
-
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
22
|
-
Requires-Dist: beautifulsoup4 (==4.12.3)
|
|
23
|
-
Requires-Dist: pandas (>=2.0.0,<3.0.0)
|
|
24
|
-
Requires-Dist: requests (>=2.31.0,<3.0.0)
|
|
25
|
-
Requires-Dist: rich (>=12.6,<14.0)
|
|
26
|
-
Requires-Dist: typer[all] (>=0.4,<0.10)
|
|
27
|
-
Project-URL: Repository, https://github.com/nvuillam/github-dependents-info
|
|
28
|
-
Description-Content-Type: text/markdown
|
|
29
|
-
|
|
30
1
|
# github-dependents-info
|
|
31
2
|
|
|
32
3
|
<div align="center">
|
|
@@ -39,7 +10,7 @@ Description-Content-Type: text/markdown
|
|
|
39
10
|
[](https://github.com/nvuillam/github-dependents-info/pulls?utf8=%E2%9C%93&q=is%3Apr%20author%3Aapp%2Fdependabot)
|
|
40
11
|
|
|
41
12
|
[](https://github.com/nvuillam/github-dependents-info/graphs/contributors/)<!-- gh-dependents-info-used-by-start -->
|
|
42
|
-
[](https://github.com/nvuillam/github-dependents-info/blob/main/docs/github-dependents-info.md)<!-- gh-dependents-info-used-by-end -->
|
|
43
14
|
[](https://github.com/sponsors/nvuillam)
|
|
44
15
|
[](https://github.com/nvuillam/github-dependents-info/actions/workflows/mega-linter.yml)
|
|
45
16
|
[](https://github.com/nvuillam/github-dependents-info/blob/master/LICENSE)
|
|
@@ -64,9 +35,11 @@ This package uses GitHub HTML to collect dependents information and can:
|
|
|
64
35
|
- Generate summary markdown file
|
|
65
36
|
- Update existing markdown by inserting **Used by** badge within tags
|
|
66
37
|
- `<!-- gh-dependents-info-used-by-start -->
|
|
67
|
-
[](https://github.com/nvuillam/github-dependents-info/blob/main/docs/github-dependents-info.md)<!-- gh-dependents-info-used-by-end -->`
|
|
68
39
|
- Handle multiple repositories packages
|
|
69
|
-
- Filter results using minimum stars
|
|
40
|
+
- Filter results using minimum stars or by repository owner
|
|
41
|
+
- Keep huge ecosystems manageable with pagination controls (`--max-scraped-pages`, `--pagination/--no-pagination`, `--page-size`)
|
|
42
|
+
- Fetch dependents faster thanks to asynchronous `httpx` requests and parallelized page scraping
|
|
70
43
|
|
|
71
44
|
|
|
72
45
|
Badges example
|
|
@@ -263,19 +236,30 @@ _________________
|
|
|
263
236
|
github-dependents-info [OPTIONS]
|
|
264
237
|
```
|
|
265
238
|
|
|
266
|
-
| Parameter
|
|
267
|
-
|
|
268
|
-
| --repo
|
|
269
|
-
| -b<br/> --badgemarkdownfile
|
|
270
|
-
|
|
271
|
-
| -
|
|
272
|
-
| -
|
|
273
|
-
| -
|
|
274
|
-
| -
|
|
275
|
-
| -
|
|
276
|
-
| -
|
|
277
|
-
| -
|
|
278
|
-
| --
|
|
239
|
+
| Parameter | Type | Description |
|
|
240
|
+
|-----------------------------------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
241
|
+
| --repo | String | Repository. Example: `oxsecurity/megalinter` |
|
|
242
|
+
| -b<br/> --badgemarkdownfile | String | _(optional)_ Path to markdown file where to insert/update **Used by** badge <br/> (must contain tags `<!-- gh-dependents-info-used-by-start -->` … `<!-- gh-dependents-info-used-by-end -->`) |
|
|
243
|
+
| -s<br/> --sort | String | _(optional)_ Sort order: name (default) or stars |
|
|
244
|
+
| -x<br/> --minstars | String | _(optional)_ If set, filters repositories to keep only those with more than X stars |
|
|
245
|
+
| -m<br/> --markdownfile | String | _(optional)_ Output markdown file file |
|
|
246
|
+
| -d<br/> --docurl | String | _(optional)_ Hyperlink to use when clicking on badge markdown file badge. (Default: link to markdown file) |
|
|
247
|
+
| -p<br/> --mergepackages | String | _(optional)_ In case of multiple packages, merge their stats in a single one in markdown and json output |
|
|
248
|
+
| -j<br/> --json | String | _(optional)_ Output in json format |
|
|
249
|
+
| -u<br/> --owner | String | _(optional)_ If set, filters repositories to keep only those owned by the specified user/organization |
|
|
250
|
+
| -n<br/> --max-scraped-pages | Integer | _(optional)_ Maximum number of GitHub pages to scrape per package (0 uses all available pages) |
|
|
251
|
+
| --pagination<br/> --no-pagination | Boolean | _(optional)_ Enable (default) or disable pagination when writing markdown output |
|
|
252
|
+
| --page-size | Integer | _(optional)_ Number of repositories per markdown page when pagination is enabled (default: 500) |
|
|
253
|
+
| -v<br/> --version | Boolean | _(optional)_ Displays version of github-dependents-info |
|
|
254
|
+
| --verbose | Boolean | _(optional)_ Verbose output |
|
|
255
|
+
|
|
256
|
+
Badge tags example (the tool replaces everything between the markers):
|
|
257
|
+
|
|
258
|
+
```markdown
|
|
259
|
+
<!-- gh-dependents-info-used-by-start -->
|
|
260
|
+
[](https://github.com/nvuillam/github-dependents-info/blob/main/docs/github-dependents-info.md)
|
|
261
|
+
<!-- gh-dependents-info-used-by-end -->
|
|
262
|
+
```
|
|
279
263
|
|
|
280
264
|
_________________
|
|
281
265
|
## 🧪 Examples
|
|
@@ -289,7 +273,7 @@ _________________
|
|
|
289
273
|
github-dependents-info --repo nvuillam/npm-groovy-lint --json
|
|
290
274
|
|
|
291
275
|
- Insert/Update **Used by** markdown badge within an existing markdown file containing tags `<!-- gh-dependents-info-used-by-start -->
|
|
292
|
-
[](https://github.com/nvuillam/github-dependents-info/blob/main/docs/github-dependents-info.md)<!-- gh-dependents-info-used-by-end -->`
|
|
293
277
|
|
|
294
278
|
github-dependents-info --repo nvuillam/npm-groovy-lint --badgemarkdownfile ./README.md
|
|
295
279
|
|
|
@@ -309,6 +293,14 @@ _________________
|
|
|
309
293
|
|
|
310
294
|
github-dependents-info --repo oxsecurity/megalinter --markdownfile ./docs/package-usage.md --sort stars --mergepackages --verbose
|
|
311
295
|
|
|
296
|
+
- Limit scraping to repositories owned by a specific organization and cap pagination to 5 pages per package
|
|
297
|
+
|
|
298
|
+
github-dependents-info --repo oxsecurity/megalinter --owner oxsecurity --max-scraped-pages 5 --verbose
|
|
299
|
+
|
|
300
|
+
- Generate paginated markdown with 250 repositories per page (use `--no-pagination` to force a single file)
|
|
301
|
+
|
|
302
|
+
github-dependents-info --repo nvuillam/npm-groovy-lint --markdownfile ./docs/package-usage.md --page-size 250 --mergepackages
|
|
303
|
+
|
|
312
304
|
## Use as GitHub Action
|
|
313
305
|
|
|
314
306
|
Allow GitHub Actions to create Pull Requests in **Settings > Actions > General**
|
|
@@ -320,7 +312,7 @@ Create a file **.github/workflows/github-dependents-info.yml** in your repositor
|
|
|
320
312
|
If will generate a new Pull Request (or replace the pending one) every time the usage stats will have changed :)
|
|
321
313
|
|
|
322
314
|
Don't forget to add tags `<!-- gh-dependents-info-used-by-start -->
|
|
323
|
-
[](https://github.com/nvuillam/github-dependents-info/blob/main/docs/github-dependents-info.md)<!-- gh-dependents-info-used-by-end -->` in your **README.md**, at the end of another badge line if you want github-dependents-info to replace its content automatically.
|
|
324
316
|
|
|
325
317
|
```yaml
|
|
326
318
|
# GitHub Dependents Info workflow
|
|
@@ -354,14 +346,14 @@ jobs:
|
|
|
354
346
|
steps:
|
|
355
347
|
# Git Checkout
|
|
356
348
|
- name: Checkout Code
|
|
357
|
-
uses: actions/checkout@
|
|
349
|
+
uses: actions/checkout@v6
|
|
358
350
|
with:
|
|
359
351
|
token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
|
|
360
352
|
fetch-depth: 0
|
|
361
353
|
|
|
362
354
|
# Collect data & generate markdown
|
|
363
355
|
- name: GitHub Dependents Info
|
|
364
|
-
uses: nvuillam/github-dependents-info@v1.
|
|
356
|
+
uses: nvuillam/github-dependents-info@v1.6.3 # If you want to always have the latest version, you can use nvuillam/github-dependents-info@main :)
|
|
365
357
|
# See documentation for variables details: https://github.com/nvuillam/github-dependents-info?tab=readme-ov-file#%EF%B8%8F-usage
|
|
366
358
|
with:
|
|
367
359
|
repo: ${{ github.repository }}
|
|
@@ -380,7 +372,7 @@ jobs:
|
|
|
380
372
|
# Create pull request
|
|
381
373
|
- name: Create Pull Request
|
|
382
374
|
id: cpr
|
|
383
|
-
uses: peter-evans/create-pull-request@
|
|
375
|
+
uses: peter-evans/create-pull-request@v8
|
|
384
376
|
with:
|
|
385
377
|
token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
|
|
386
378
|
branch: github-dependents-info-auto-update
|
|
@@ -411,4 +403,3 @@ This package has been inspired by stackexchange post [How to use GitHub API to g
|
|
|
411
403
|
- [Mo Ganji](https://www.linkedin.com/in/mohganji/) <!-- markdown-link-check-disable-line -->
|
|
412
404
|
|
|
413
405
|
This project was generated with [`python-package-template`](https://github.com/TezRomacH/python-package-template)
|
|
414
|
-
|
{github_dependents_info-1.6.2 → github_dependents_info-2.0.0}/github_dependents_info/__main__.py
RENAMED
|
@@ -39,6 +39,7 @@ def main(
|
|
|
39
39
|
badge_color: str = typer.Option("informational", "-c", "--markdownbadgecolor", help="Markdown badge color"),
|
|
40
40
|
sort_key: str = typer.Option(None, "-s", "--sort", help="Sort of name(default) or stars"),
|
|
41
41
|
min_stars: int = typer.Option(None, "-x", "--minstars", help="Filter dependents with less than X stars"),
|
|
42
|
+
time_delay: float = typer.Option(0.1, "-t", "--timedelay", help="seconds delayed between two requests to github"),
|
|
42
43
|
json_output: bool = typer.Option(
|
|
43
44
|
False,
|
|
44
45
|
"-j",
|
|
@@ -47,7 +48,6 @@ def main(
|
|
|
47
48
|
),
|
|
48
49
|
csv_directory: str = typer.Option(
|
|
49
50
|
None,
|
|
50
|
-
"-c",
|
|
51
51
|
"--csvdirectory",
|
|
52
52
|
help="Path to directory for CSV files",
|
|
53
53
|
),
|
|
@@ -59,7 +59,6 @@ def main(
|
|
|
59
59
|
),
|
|
60
60
|
verbose: bool = typer.Option(
|
|
61
61
|
False,
|
|
62
|
-
"-d",
|
|
63
62
|
"--verbose",
|
|
64
63
|
help="Prints the version of github-dependents-info package",
|
|
65
64
|
),
|
|
@@ -77,6 +76,16 @@ def main(
|
|
|
77
76
|
is_eager=True,
|
|
78
77
|
help="Prints the version of the github-dependents-info package.",
|
|
79
78
|
),
|
|
79
|
+
owner: str = typer.Option(
|
|
80
|
+
None, "-u", "--owner", help="Filter dependent repositories with a specific owner (ex: oxsecurity)"
|
|
81
|
+
),
|
|
82
|
+
max_scraped_pages: int = typer.Option(
|
|
83
|
+
0, "-n", "--max-scraped-pages", help="Maximum number of pages to scrape per package (0 means no limit)"
|
|
84
|
+
),
|
|
85
|
+
pagination: bool = typer.Option(
|
|
86
|
+
True, "--pagination/--no-pagination", help="Enable pagination to split results into multiple files"
|
|
87
|
+
),
|
|
88
|
+
page_size: int = typer.Option(500, "--page-size", help="Number of results per page when pagination is enabled"),
|
|
80
89
|
) -> None:
|
|
81
90
|
# Init logger
|
|
82
91
|
if verbose is True:
|
|
@@ -109,6 +118,11 @@ def main(
|
|
|
109
118
|
markdown_file=markdown_file,
|
|
110
119
|
badge_color=badge_color,
|
|
111
120
|
merge_packages=merge_packages,
|
|
121
|
+
owner=owner,
|
|
122
|
+
time_delay=time_delay,
|
|
123
|
+
max_scraped_pages=max_scraped_pages,
|
|
124
|
+
pagination=pagination,
|
|
125
|
+
page_size=page_size,
|
|
112
126
|
)
|
|
113
127
|
# Collect data
|
|
114
128
|
gh_deps_info.collect()
|