github-dependents-info

Collect information about dependencies between a github repo and other repositories.

_________________

🚀 Features

GitHub API does not allow to collect information about package usage (Used by on home, Dependents in insights section)

This package uses GitHub HTML to collect dependents information and can:

Automate all the actions below using a simple GitHub Action !
Output as text
Output as json (including shields.io markdown badges)
Generate summary markdown file
Optionally add an AI-generated usage summary (via litellm) when an LLM API key is present
Update existing markdown by inserting Used by badge within tags

Handle multiple repositories packages
Filter results using minimum stars or by repository owner
Keep huge ecosystems manageable with pagination controls (--max-scraped-pages, --pagination/--no-pagination, --page-size)
Fetch dependents faster thanks to asynchronous httpx requests and parallelized page scraping

Badges example

JSON output

Note: when AI usage summary is enabled and an LLM API key is present, the JSON output also includes llm_summary.

{
    "all_public_dependent_repos": [
        {
            "name": "CIT-SeniorDesign/CIT-SeniorDesign.github.io",
            "stars": 0
        },
        {
            "name": "Moaz-Adel/Jobsity-Challenge",
            "stars": 0
        },
        {
            "name": "Moaz-Adel/automation-exercise-cypress",
            "stars": 0
        },
        {
            "name": "RecuencoJones/vscode-groovy-lint-issue",
            "stars": 0
        },
        {
            "name": "aboe026/data-structures",
            "stars": 0
        },
        {
            "name": "aboe026/shields.io-badge-results",
            "stars": 0
        },
        {
            "name": "aboe026/software-update-checker",
            "stars": 2
        },
        {
            "name": "katalon-labs/katalon-recorder-extension",
            "stars": 0
        },
        {
            "name": "mashafrancis/sa-jenkins",
            "stars": 0
        },
        {
            "name": "nvuillam/vscode-groovy-lint",
            "stars": 52
        },
        {
            "name": "run2cmd/dotfiles",
            "stars": 2
        }
    ],
    "packages": [
        {
            "id": null,
            "name": "nvuillam/npm-groovy-lint",
            "url": "https://github.com/nvuillam/npm-groovy-lint/network/dependents",
            "public_dependent_stars": 56,
            "public_dependents": [
                {
                    "name": "CIT-SeniorDesign/CIT-SeniorDesign.github.io",
                    "stars": 0
                },
                {
                    "name": "Moaz-Adel/Jobsity-Challenge",
                    "stars": 0
                },
                {
                    "name": "Moaz-Adel/automation-exercise-cypress",
                    "stars": 0
                },
                {
                    "name": "RecuencoJones/vscode-groovy-lint-issue",
                    "stars": 0
                },
                {
                    "name": "aboe026/data-structures",
                    "stars": 0
                },
                {
                    "name": "aboe026/shields.io-badge-results",
                    "stars": 0
                },
                {
                    "name": "aboe026/software-update-checker",
                    "stars": 2
                },
                {
                    "name": "katalon-labs/katalon-recorder-extension",
                    "stars": 0
                },
                {
                    "name": "mashafrancis/sa-jenkins",
                    "stars": 0
                },
                {
                    "name": "nvuillam/vscode-groovy-lint",
                    "stars": 52
                },
                {
                    "name": "run2cmd/dotfiles",
                    "stars": 2
                }
            ],
            "public_dependents_number": 11,
            "private_dependents_number": 4,
            "total_dependents_number": 15,
            "badges": {
                "total": "",
                "public": "",
                "private": "",
                "stars": ""
            }
        }
    ],
    "total_dependents_number": 15,
    "public_dependents_number": 11,
    "private_dependents_number": 4,
    "public_dependents_stars": 56,
    "badges": {
        "total": "",
        "public": "",
        "private": "",
        "stars": ""
    }
}

Markdown output for single package

# Dependents stats for nvuillam/npm-groovy-lint
Package nvuillam/npm-groovy-lint




| Repository                                                                                                    | Stars |
|:--------------------------------------------------------------------------------------------------------------|------:|
| CIT-SeniorDesign/CIT-SeniorDesign.github.io |     0 |
| Moaz-Adel/Jobsity-Challenge                                 |     0 |
| Moaz-Adel/automation-exercise-cypress             |     0 |
| RecuencoJones/vscode-groovy-lint-issue           |     0 |
| aboe026/data-structures                                         |     0 |
| aboe026/shields.io-badge-results                       |     0 |
| aboe026/software-update-checker                         |     2 |
| katalon-labs/katalon-recorder-extension         |     0 |
| mashafrancis/sa-jenkins                                         |     0 |
| nvuillam/vscode-groovy-lint                                 |    52 |
| run2cmd/dotfiles                                                       |     2 |
_Generated by github-dependents-info_

Note: If your repository packages have millions of dependents, running github-dependent-infos could take hours, as it works by browsing and scraping HTML pages returned by GitHub. For example, angular/angular dependents did run during several hours !

Installation
Usage
Examples
Use as GitHub Action

_________________

⚙️ Installation

pip install -U github-dependents-info

or install with Poetry

poetry add github-dependents-info

_________________

🛠️ Usage

github-dependents-info [OPTIONS]

| Parameter | Type | Description | |-----------|--------|----------------------------------------------| | --repo | String | Repository. Example: oxsecurity/megalinter | | -b
--badgemarkdownfile | String | _(optional)_ Path to markdown file where to insert/update Used by badge
(must contain tags ) | | -s
--sort | String | _(optional)_ Sort order: name (default) or stars | | -x
--minstars | String | _(optional)_ If set, filters repositories to keep only those with more than X stars | | -m
--markdownfile | String | _(optional)_ Output markdown file file | | -d
--docurl | String | _(optional)_ Hyperlink to use when clicking on badge markdown file badge. (Default: link to markdown file) | | -p
--mergepackages | String | _(optional)_ In case of multiple packages, merge their stats in a single one in markdown and json output | | -j
--json | String | _(optional)_ Output in json format | | -u
--owner | String | _(optional)_ If set, filters repositories to keep only those owned by the specified user/organization | | -n
--max-scraped-pages | Integer | _(optional)_ Maximum number of GitHub pages to scrape per package (0 uses all available pages) | | --pagination
--no-pagination | Boolean | _(optional)_ Enable (default) or disable pagination when writing markdown output | | --page-size | Integer | _(optional)_ Number of repositories per markdown page when pagination is enabled (default: 500) | | --llm-summary
--no-llm-summary | Boolean | _(optional)_ Generate an AI usage summary in markdown output when an LLM API key is present (default: enabled) | | --llm-model | String | _(optional)_ LiteLLM model to use for the summary. If not set, a lightweight model is selected based on the detected API key provider | | --llm-max-repos | Integer | _(optional)_ Max dependent repos included in the summary prompt payload (default: 500) | | --llm-max-words | Integer | _(optional)_ Max words for the generated summary (default: 300) | | --llm-timeout | Float | _(optional)_ Timeout (seconds) for the summary LLM call (default: 120) | | -v
--version | Boolean | _(optional)_ Displays version of github-dependents-info | | --verbose | Boolean | _(optional)_ Verbose output |

Badge tags example (the tool replaces everything between the markers):

<!-- gh-dependents-info-used-by-start -->
<!-- gh-dependents-info-used-by-end -->

_________________

🧪 Examples

Text output

github-dependents-info --repo nvuillam/npm-groovy-lint

JSON output

github-dependents-info --repo nvuillam/npm-groovy-lint --json

Insert/Update Used by markdown badge within an existing markdown file containing tags

github-dependents-info --repo nvuillam/npm-groovy-lint --badgemarkdownfile ./README.md

Build markdown file with dependent repos (single package), sorted by name

github-dependents-info --repo nvuillam/npm-groovy-lint --markdownfile ./docs/package-usage.md --verbose

Build markdown file with dependent repos (single package), with minimum 10 stars

github-dependents-info --repo nvuillam/npm-groovy-lint --markdownfile ./docs/package-usage.md --minstars 10 --verbose

Build markdown file with dependent repos (multiple package), sorted by stars

github-dependents-info --repo oxsecurity/megalinter --markdownfile ./docs/package-usage.md --sort stars --verbose

Build markdown file with dependent repos (multiple package), with merged list of packages in output markdown

github-dependents-info --repo oxsecurity/megalinter --markdownfile ./docs/package-usage.md --sort stars --mergepackages --verbose

Limit scraping to repositories owned by a specific organization and cap pagination to 5 pages per package

github-dependents-info --repo oxsecurity/megalinter --owner oxsecurity --max-scraped-pages 5 --verbose

Generate paginated markdown with 250 repositories per page (use --no-pagination to force a single file)

github-dependents-info --repo nvuillam/npm-groovy-lint --markdownfile ./docs/package-usage.md --page-size 250 --mergepackages

Disable AI usage summary generation

github-dependents-info --repo nvuillam/npm-groovy-lint --markdownfile ./docs/package-usage.md --no-llm-summary

Force a specific LiteLLM model for the summary

github-dependents-info --repo nvuillam/npm-groovy-lint --markdownfile ./docs/package-usage.md --llm-model gpt-4o-mini

Generate markdown with AI summary using OPENAI_API_KEY

GEMINI_API_KEY=YOUR_KEY github-dependents-info --repo nvuillam/npm-groovy-lint --markdownfile ./docs/package-usage.md --llm-model gemini-3-flash-preview

AI usage summary (optional)

If an LLM API key is detected in the environment (for example OPENAI_API_KEY), the tool will call a lightweight model (via litellm) to generate a short usage summary and include it in the generated markdown.

Supported provider env vars (most common):

- OpenAI: OPENAI_API_KEY - Azure OpenAI: AZURE_OPENAI_API_KEY - Anthropic: ANTHROPIC_API_KEY - Google Gemini: GEMINI_API_KEY (or GOOGLE_API_KEY) - Mistral: MISTRAL_API_KEY - Cohere: COHERE_API_KEY - Groq: GROQ_API_KEY

Disable with --no-llm-summary (or env var GITHUB_DEPENDENTS_INFO_LLM_SUMMARY=false)
Override model with --llm-model (or env var GITHUB_DEPENDENTS_INFO_LLM_MODEL / LITELLM_MODEL)
Adjust max summary length with --llm-max-words (or env var GITHUB_DEPENDENTS_INFO_LLM_MAX_WORDS)
The summary is cached in --csvdirectory (file llm_summary_.json) and reused on subsequent runs
A previously generated summary is never lost: if a new summary can not be generated (no API key anymore, no credit left, rate limit, timeout...), the summary found in the cache or in the existing --markdownfile is reused

Use as GitHub Action

Allow GitHub Actions to create Pull Requests in Settings > Actions > General

!image

Create a file .github/workflows/github-dependents-info.yml in your repository with the following YAML content.

If will generate a new Pull Request (or replace the pending one) every time the usage stats will have changed :)

Don't forget to add tags in your README.md, at the end of another badge line if you want github-dependents-info to replace its content automatically.

# GitHub Dependents Info workflow More info at https://github.com/nvuillam/github-dependents-info/ name: GitHub Dependents Info Let by default on: # On manual launch workflow_dispatch: # On every push on selected branches (usually just main) push: branches: [main,master,setup-gdi] # Scheduled interval: Use CRON format https://crontab.guru/ schedule: - cron: "0 0 0" # Every sunday at midnight permissions: read-all concurrency: group: ${{ github.ref }}-${{ github.workflow }} cancel-in-progress: true jobs: build: name: GitHub Dependents Info runs-on: ubuntu-latest permissions: contents: write pull-requests: write steps: # Git Checkout - name: Checkout Code uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6 with: token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }} fetch-depth: 0 persist-credentials: false # Collect data & generate markdown - name: GitHub Dependents Info uses: nvuillam/github-dependents-info@fa4a7bc373174a9060ad9935ee32557eef05ea89 # v1.6.3 # See documentation for variables details: https://github.com/nvuillam/github-dependents-info?tab=readme-ov-file#%EF%B8%8F-usage with: repo: ${{ github.repository }} outputrepo: ${{ github.repository }} # markdownfile: docs/github-dependents-info.md # badgemarkdownfile: README.md # sort: stars # minstars: "0" # pagination: "true" # set to "false" to write a single markdown file # page-size: "500" # number of repositories per markdown page # max-scraped-pages: "0" # max pages to scrape per package (0 = no limit) # llm-summary: "true" # set to "false" to disable AI usage summary # llm-model: "" # optional: override LiteLLM model (example: gpt-4o-mini, gemini-3-flash-preview) # llm-max-repos: "500" # optional: cap repos sent to the summary prompt # llm-max-words: "250" # optional: cap summary length # llm-timeout: "120" # optional: timeout (seconds) for the LLM call env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # To enable the AI usage summary, provide one of the supported provider API keys, for example: # OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }} # GEMINI_API_KEY: ${{ secrets.GEMINI_API_KEY }} # Workaround for git issues - name: Prepare commit run: sudo chown -R $USER:$USER .

# Create pull request - name: Create Pull Request id: cpr uses: peter-evans/create-pull-request@5f6978faf089d4d20b00c7766989d076bb2fc7f1 # v8 with: token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }} branch: github-dependents-info-auto-update commit-message: "[GitHub Dependents Info] Updated markdown file(s)" delete-branch: true title: "[GitHub Dependents Info] Updated markdown file" body: "_Generated with github-dependents-info, by Nicolas Vuillamy_" labels: documentation - name: Create PR output run: | echo "Pull Request Number - ${STEPS_CPR_OUTPUTS_PULL_REQUEST_NUMBER}" echo "Pull Request URL - ${STEPS_CPR_OUTPUTS_PULL_REQUEST_URL}" env: STEPS_CPR_OUTPUTS_PULL_REQUEST_NUMBER: ${{ steps.cpr.outputs.pull-request-number }} STEPS_CPR_OUTPUTS_PULL_REQUEST_URL: ${{ steps.cpr.outputs.pull-request-url }}

GitHub Action inputs

Action inputs are named after the CLI options, without the leading --. Boolean CLI flags such as --no-pagination become inputs with a "true" / "false" value.

| Input |----------------------|- | repo | outputrepo | markdownfile | badgemarkdownfile | docurl | markdownbadgecolor | sort | minstars | timedelay | csvdirectory | mergepackages | json | verbose | overwrite | owner | max-scraped-pages | pagination | no-pagination | page-size | llm-summary | llm-model | llm-max-repos | llm-max-words | llm-timeout | Description | CLI equivalent | Default | -------------------------------------------------------------------------------|--------------------------------------|------------------------------------| | Owner and name of the repository (required) | --repo | _(required)_ | | Owner and name of the output repository, if different from repo | --outputrepo | "" | | Path of the output markdown file | --markdownfile | "docs/github-dependents-info.md" | | File where badges are replaced (between the gh-dependents-info-used-by tags) | --badgemarkdownfile | "README.md" | | Custom URL for the badges hyperlink | --docurl | "" | | Color of the generated badges | --markdownbadgecolor | "informational" | | Sort criteria: stars or name | --sort | "stars" | | Minimum number of stars to appear in the results | --minstars | "0" | | Delay in seconds between GitHub requests | --timedelay | "0.1" | | Directory where CSV progress files are written | --csvdirectory | "" | | true to merge multiple packages into a single result | --mergepackages | "false" | | true to emit JSON output | --json | "false" | | true to enable verbose logging | --verbose | "false" | | true to overwrite existing CSV progress files | --overwrite | "false" | | Filter dependent repositories by owner | --owner | "" | | Max pages to scrape per package (0 = no limit) | --max-scraped-pages | "0" | | false to write a single markdown file instead of multiple pages | --pagination / --no-pagination | "true" | | true to disable pagination (same as pagination: "false") | --no-pagination | "false" | | Number of repositories per markdown page when pagination is enabled | --page-size | "500" | | false to disable the AI usage summary | --llm-summary / --no-llm-summary | "true" | | LiteLLM model for the AI usage summary | --llm-model | "" | | Max dependent repos included in the summary prompt | --llm-max-repos | "500" | | Max words for the generated summary | --llm-max-words | "250" | | Timeout (seconds) for the summary LLM call | --llm-timeout | "120" |

_________________

🛡 License

This project is licensed under the terms of the MIT license. See LICENSE for more details.

_________________

Credits

This package has been inspired by stackexchange post How to use GitHub API to get a repository's dependents information in GitHub?

This project was generated with python-package-template

Package nvuillam/npm-groovy-lint

nvuillam/github-dependents-info: Collect information about dependencies between a github repo and other repositories. Results available in JSON, markdown and badge

github-dependents-info

🚀 Features

⚙️ Installation

🛠️ Usage

🧪 Examples

AI usage summary (optional)

Use as GitHub Action

More info at https://github.com/nvuillam/github-dependents-info/

Let by default

GitHub Action inputs

🛡 License

Credits

Reading Mode

Related Stories

A/SIDE – Private photo sharing and encrypted messages

What is a light-day? The milestone Voyager 1 is closing in on

Casio Watches of the 1980s

Ex-Meta Researcher Torrented Pirated Books, Deleted It 'Due to Litigation'

Malware uses LLMs to rank victims by how much they're worth

Related Stories