Package: github-dependents-info
github-dependents-infoCollect information about dependencies between a github repo and other repositories.🚀 FeaturesGitHub API does not allow to collect information about package usage (Used byon home,Dependentsin insights section)This package uses GitHub HTML to collect dependents information and can:Automate all the actions belowusing a simple GitHub Action!Output as textOutput as json (including shields.io markdown badges)Generate summary markdown fileUpdate existing markdown by insertingUsed bybadge within tags<!-- gh-dependents-info-used-by-start --> [![Generated by github-dependents-info](https://img.shields.io/static/v1?label=Used%20by&message=10&color=informational&logo=slickpic)](https://github.com/nvuillam/github-dependents-info/blob/main/docs/github-dependents-info.md)<!-- gh-dependents-info-used-by-end -->Handle multiple repositories packagesFilter results using minimum starsBadges exampleJSON output{"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":"[![](https://img.shields.io/static/v1?label=Used%20by&message=15&color=informational&logo=slickpic)](https://github.com/nvuillam/npm-groovy-lint/network/dependents)","public":"[![](https://img.shields.io/static/v1?label=Used%20by%20(public)&message=11&color=informational&logo=slickpic)](https://github.com/nvuillam/npm-groovy-lint/network/dependents)","private":"[![](https://img.shields.io/static/v1?label=Used%20by%20(private)&message=4&color=informational&logo=slickpic)](https://github.com/nvuillam/npm-groovy-lint/network/dependents)","stars":"[![](https://img.shields.io/static/v1?label=Used%20by%20(stars)&message=56&color=informational&logo=slickpic)](https://github.com/nvuillam/npm-groovy-lint/network/dependents)"}}],"total_dependents_number":15,"public_dependents_number":11,"private_dependents_number":4,"public_dependents_stars":56,"badges":{"total":"[![](https://img.shields.io/static/v1?label=Used%20by&message=15&color=informational&logo=slickpic)](https://github.com/nvuillam/npm-groovy-lint/network/dependents)","public":"[![](https://img.shields.io/static/v1?label=Used%20by%20(public)&message=11&color=informational&logo=slickpic)](https://github.com/nvuillam/npm-groovy-lint/network/dependents)","private":"[![](https://img.shields.io/static/v1?label=Used%20by%20(private)&message=4&color=informational&logo=slickpic)](https://github.com/nvuillam/npm-groovy-lint/network/dependents)","stars":"[![](https://img.shields.io/static/v1?label=Used%20by%20(stars)&message=56&color=informational&logo=slickpic)](https://github.com/nvuillam/npm-groovy-lint/network/dependents)"}}Markdown output for single package# Dependents stats for nvuillam/npm-groovy-lint## Package nvuillam/npm-groovy-lint[![](https://img.shields.io/static/v1?label=Used%20by&message=15&color=informational&logo=slickpic)](https://github.com/nvuillam/npm-groovy-lint/network/dependents)
[![](https://img.shields.io/static/v1?label=Used%20by%20(public)&message=11&color=informational&logo=slickpic)](https://github.com/nvuillam/npm-groovy-lint/network/dependents)
[![](https://img.shields.io/static/v1?label=Used%20by%20(private)&message=4&color=informational&logo=slickpic)](https://github.com/nvuillam/npm-groovy-lint/network/dependents)
[![](https://img.shields.io/static/v1?label=Used%20by%20(stars)&message=56&color=informational&logo=slickpic)](https://github.com/nvuillam/npm-groovy-lint/network/dependents)

| Repository                                                                                                    | Stars |
|:--------------------------------------------------------------------------------------------------------------|------:|
| [CIT-SeniorDesign/CIT-SeniorDesign.github.io](https://github.com/CIT-SeniorDesign/CIT-SeniorDesign.github.io) |     0 |
| [Moaz-Adel/Jobsity-Challenge](https://github.com/Moaz-Adel/Jobsity-Challenge)                                 |     0 |
| [Moaz-Adel/automation-exercise-cypress](https://github.com/Moaz-Adel/automation-exercise-cypress)             |     0 |
| [RecuencoJones/vscode-groovy-lint-issue](https://github.com/RecuencoJones/vscode-groovy-lint-issue)           |     0 |
| [aboe026/data-structures](https://github.com/aboe026/data-structures)                                         |     0 |
| [aboe026/shields.io-badge-results](https://github.com/aboe026/shields.io-badge-results)                       |     0 |
| [aboe026/software-update-checker](https://github.com/aboe026/software-update-checker)                         |     2 |
| [katalon-labs/katalon-recorder-extension](https://github.com/katalon-labs/katalon-recorder-extension)         |     0 |
| [mashafrancis/sa-jenkins](https://github.com/mashafrancis/sa-jenkins)                                         |     0 |
| [nvuillam/vscode-groovy-lint](https://github.com/nvuillam/vscode-groovy-lint)                                 |    52 |
| [run2cmd/dotfiles](https://github.com/run2cmd/dotfiles)                                                       |     2 |_Generated by [github-dependents-info](https://github.com/nvuillam/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 dependentsdid run during several hours !InstallationUsageExamplesUse as GitHub Action⚙️ Installationpipinstall-Ugithub-dependents-infoor install withPoetrypoetryaddgithub-dependents-info🛠️ Usagegithub-dependents-info[OPTIONS]ParameterTypeDescription--repoStringRepository. Example:oxsecurity/megalinter-b--badgemarkdownfileString(optional)Path to markdown file where to insert/updateUsed bybadge(must contain tags ``)-s--sortString(optional)Sort order: name (default) or stars-x--minstarsString(optional)If set, filters repositories to keep only those with more than X stars-m--markdownfileString(optional)Output markdown file file-d--docurlString(optional)Hyperlink to use when clicking on badge markdown file badge. (Default: link to markdown file)-p--mergepackagesString(optional)In case of multiple packages, merge their stats in a single one in markdown and json output-j--jsonString(optional)Output in json format-v--versionBoolean(optional)Displays version of github-dependents-info--verboseBoolean(optional)Verbose output🧪 ExamplesText outputgithub-dependents-info --repo nvuillam/npm-groovy-lintJSON outputgithub-dependents-info --repo nvuillam/npm-groovy-lint --jsonInsert/UpdateUsed bymarkdown badge within an existing markdown file containing tags<!-- gh-dependents-info-used-by-start --> [![Generated by github-dependents-info](https://img.shields.io/static/v1?label=Used%20by&message=10&color=informational&logo=slickpic)](https://github.com/nvuillam/github-dependents-info/blob/main/docs/github-dependents-info.md)<!-- gh-dependents-info-used-by-end -->github-dependents-info --repo nvuillam/npm-groovy-lint --badgemarkdownfile ./README.mdBuild markdown file with dependent repos (single package), sorted by namegithub-dependents-info --repo nvuillam/npm-groovy-lint --markdownfile ./docs/package-usage.md --verboseBuild markdown file with dependent repos (single package), with minimum 10 starsgithub-dependents-info --repo nvuillam/npm-groovy-lint --markdownfile ./docs/package-usage.md --minstars 10 --verboseBuild markdown file with dependent repos (multiple package), sorted by starsgithub-dependents-info --repo oxsecurity/megalinter --markdownfile ./docs/package-usage.md --sort stars --verboseBuild markdown file with dependent repos (multiple package), with merged list of packages in output markdowngithub-dependents-info --repo oxsecurity/megalinter --markdownfile ./docs/package-usage.md --sort stars --mergepackages --verboseUse as GitHub ActionAllow GitHub Actions to create Pull Requests inSettings > Actions > GeneralCreate a file.github/workflows/github-dependents-info.ymlin 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<!-- gh-dependents-info-used-by-start --> [![Generated by github-dependents-info](https://img.shields.io/static/v1?label=Used%20by&message=10&color=informational&logo=slickpic)](https://github.com/nvuillam/github-dependents-info/blob/main/docs/github-dependents-info.md)<!-- gh-dependents-info-used-by-end -->in yourREADME.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 defaulton:# On manual launchworkflow_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:"00**0"# Every sunday at midnightpermissions:read-allconcurrency:group:${{ github.ref }}-${{ github.workflow }}cancel-in-progress:truejobs:build:name:GitHub Dependents Inforuns-on:ubuntu-latestpermissions:contents:writepull-requests:writesteps:# Git Checkout-name:Checkout Codeuses:actions/checkout@v4with:token:${{ secrets.PAT || secrets.GITHUB_TOKEN }}fetch-depth:0# Collect data & generate markdown-name:GitHub Dependents Infouses:nvuillam/github-dependents-info@v1.5.1# If you trust me enough you can replace version by "main" :)# See documentation for variables details: https://github.com/nvuillam/github-dependents-info?tab=readme-ov-file#%EF%B8%8F-usagewith:repo:${{ github.repository }}outputrepo:${{ github.repository }}# markdownfile: docs/github-dependents-info.md# badgemarkdownfile: README.md# sort: stars# minstars: "0"env:GITHUB_TOKEN:${{ secrets.GITHUB_TOKEN }}# Workaround for git issues-name:Prepare commitrun:sudo chown -R $USER:$USER .# Create pull request-name:Create Pull Requestid:cpruses:peter-evans/create-pull-request@v6with:token:${{ secrets.PAT || secrets.GITHUB_TOKEN  }}branch:github-dependents-info-auto-updatecommit-message:"[GitHubDependentsInfo]Updatedmarkdownfile(s)"delete-branch:truetitle:"[GitHubDependentsInfo]Updatedmarkdownfile"body:"_Generatedwith[github-dependents-info](https://github.com/nvuillam/github-dependents-info),by[NicolasVuillamy](https://github.com/nvuillam)_"labels:documentation-name:Create PR outputrun:|echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}"echo "Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}"🛡 LicenseThis project is licensed under the terms of theMITlicense. SeeLICENSEfor more details.CreditsThis package has been inspired by stackexchange postHow to use GitHub API to get a repository's dependents information in GitHub?Bertrand MartelmuvafMo GanjiThis project was generated withpython-package-template