Generate Used By badge from GitHub's dependencies information.
Project description
Used By
Create and update Used By badge by leveraging GitHub's dependencies information via a pull request.
Usage
Run as GitHub Action
Create a new GitHub Actions workflow in your project, e.g. at .github/workflows/used-by.yml
steps:
- uses: actions/checkout@v4
- uses: shenxianpeng/used-by@main # or tag
with:
repo: '${{ github.repository }}' # current repository
update-badge: 'true'
# create pull request if changed
- name: Create Pull Request
uses: peter-evans/create-pull-request@v6
with:
add-paths: "README.md" # the file path to commit
commit-message: "chore: update used-by badge by github-actions[bot]"
title: "chore: automatic update used-by badge"
base: main
labels: documentation
delete-branch: true
[!IMPORTANT] To create pull request with
peter-evans/create-pull-request@v6
requires changing Workflow permissions to Read and write permissions and enabling Allow GitHub Actions to create and approve pull requests.
Required Inputs
repo
:
- Description: GitHub repository name. e.g. shenxianpeng/used-by. Defaults to shenxianpeng/used-by.
- Default: 'shenxianpeng/used-by'
Optional Inputs
file-path
:
- Description: The path to file. Defaults to README.md.
- Default: 'README.md'
badge-label
:
- Description: The badge display name. Defaults to Used by.
- Default: 'Used by'
badge-color
:
- Description: The badge display color. Defaults to informational.
- Default: 'informational'
badge-logo
:
- Description: The badge display color. Defaults to slickpic.
- Default: 'slickpic'
update-badge
:
- Description: The badge display color. Defaults to false.
- Default: 'false'
For supported values of badge-label
, badge-color
and badge-logo
, see https://shields.io/badges/static-badge
Install used-by
CLI
pip install git+https://github.com/shenxianpeng/used-by.git@main
Help of used-by
CLI
used-by --help
usage: used-by [-h] [--repo REPO] [--file-path FILE_PATH] [--badge-label BADGE_LABEL] [--badge-color BADGE_COLOR] [--badge-logo BADGE_LOGO] [--update-badge UPDATE_BADGE]
Generate a Used By badge from GitHub dependents information.
options:
-h, --help show this help message and exit
--repo REPO GitHub repository name (e.g., shenxianpeng/used-by).
--file-path FILE_PATH
The path to the file where the badge will be added. Defaults to README.md.
--badge-label BADGE_LABEL
The badge display name. Defaults to Used by.
--badge-color BADGE_COLOR
The badge display color. Defaults to informational.
--badge-logo BADGE_LOGO
The badge display logo. Defaults to slickpic.
--update-badge UPDATE_BADGE
Add or update badge if set. Defaults to False.
Run used-by
CLI
# generate markdown makeup text by default
$ used-by --repo shenxianpeng/used-by
Add Used By badge in README
Copy following content to show Used By badge in your repository README.
Markdown
[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=4&color=informational&logo=slickpic)](https://github.com/shenxianpeng/used-by/network/dependents)<!-- used by badge -->
reStructuredText
.. image:: https://img.shields.io/static/v1?label=Used%20by&message=0&color=informational&logo=slickpic
:target: https://github.com/shenxianpeng/used-by/network/dependents
:alt: used-by
License
MIT © 2024-present Xianpeng Shen
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
File details
Details for the file used_by-0.1.4-py3-none-any.whl
.
File metadata
- Download URL: used_by-0.1.4-py3-none-any.whl
- Upload date:
- Size: 5.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6ae82ec370cf45679fd99a4a2a2ae1ef90b39ffe1cca5da2260eee3164ae86a4 |
|
MD5 | 378441f2d3d48963b57ca16e4ccb5540 |
|
BLAKE2b-256 | 3fafc8bf097b09df18a4791ce05a1565a2af67272ed3c53e3405cb01f11bc204 |