# ghcr-badge: Generate ghcr.io container's status badge
[![1] ![2] ![4]](https://github.com/eggplants/ghcr-badge/pkgs/container/ghcr-badge)
[](
<https://badge.fury.io/py/ghcr-badge>
) [](
<https://results.pre-commit.ci/latest/github/eggplants/ghcr-badge/master>
) [](
<https://codeclimate.com/github/eggplants/ghcr-badge/maintainability>
) [](
<https://github.com/eggplants/ghcr-badge/actions/workflows/release.yml>
)
## Motivation
<https://github.com/badges/shields/issues/5594>
## Deployment
[](
<https://deta.space/discovery/@eggplants/ghcrbadge>
)
- <https://ghcr-badge.egpl.dev/>
- [](https://ghcr-badge.egpl.dev)
- <https://ghcr-badge.deta.dev/>
- [](https://ghcr-badge.deta.dev)
## Available paths
- `/<package_owner>/<package_name>/tags?color=...&ignore=...&n=...&label=...&trim=...`
- defaults: `color=#44cc11`, `ignore=latest`, `n=3`, `label=image tags`
- <https://ghcr-badge.egpl.dev/eggplants/ghcr-badge/tags?trim=major>
- 👉: ![1]
- `/<package_owner>/<package_name>/latest_tag?color=...&ignore=...&label=...&trim=...`
- defaults: `color=#44cc11`, `ignore=latest`, `label=version`
- <https://ghcr-badge.egpl.dev/eggplants/ghcr-badge/latest_tag?trim=major&label=latest>
- 👉: ![2]
- `/<package_owner>/<package_name>/develop_tag?color=...&label=...`
- defaults: `color=#44cc11`, `label=develop`
- <https://ghcr-badge.egpl.dev/ptr727/plexcleaner/develop_tag>
- 👉: ![3]
- `/<package_owner>/<package_name>/size?color=...&tag=...&label=...&trim=...`
- defaults: `color=#44cc11`, `tag=latest`, `label=image size`
- <https://ghcr-badge.egpl.dev/eggplants/ghcr-badge/size>
- 👉: ![4]
## Common parameters
### `label` parameter
- `label=hello`: 
### `ignore` parameter
Use the ignore parameter to filter returned tags, supports pattern matching and a comma separated list.
- `ignore=latest` ignores the `latest` tag (default).
- `ignore=sha256*` ignores all tags prefixed with `sha256`.
- `ignore=v0.0.1,latest,sha256*` ignores the `latest` and `v0.0.1` tags, and all tags prefixed with `sha256*`.
### `trim` parameter
- `trim=patch` trims `^v?\d+\.\d+\.\d+[^.]*$` tags.
- `trim=major` trims `^v?\d+\.\d+[^.]*$` tags.
### `color` parameter
Available color names and hex codes are listed on [here](https://github.com/jongracecox/anybadge#colors).
## Note
Generated badge will be cached for 3666 seconds in GitHub's [Camo](https://github.com/atmos/camo) server.
To update immediately, send PURGE request to the badge Camo link.
```bash
curl -X PURGE "https://camo.githubusercontent.com/..."
```
[1]: <https://ghcr-badge.egpl.dev/eggplants/ghcr-badge/tags?trim=major>
[2]: <https://ghcr-badge.egpl.dev/eggplants/ghcr-badge/latest_tag?trim=major&label=latest>
[3]: <https://ghcr-badge.egpl.dev/ptr727/plexcleaner/develop_tag>
[4]: <https://ghcr-badge.egpl.dev/eggplants/ghcr-badge/size>
## Development
1. Install [`poetry`](https://python-poetry.org/docs/#installation)
1. Run `poetry install && poetry shell && pre-commit install`
1. Launch live server with `task dev`
Raw data
{
"_id": null,
"home_page": "https://github.com/eggplants/ghcr-badge",
"name": "ghcr-badge",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<3.12",
"maintainer_email": "",
"keywords": "github-container-registry,badge,ghcr",
"author": "eggplants",
"author_email": "w10776e8w@yahoo.co.jp",
"download_url": "https://files.pythonhosted.org/packages/3f/d4/19470c93a4de15824878ddef030ffb3f0d3a7d894873289efc50cb8125cd/ghcr_badge-0.3.3.tar.gz",
"platform": null,
"description": "# ghcr-badge: Generate ghcr.io container's status badge\n\n[![1] ![2] ![4]](https://github.com/eggplants/ghcr-badge/pkgs/container/ghcr-badge)\n\n[](\n <https://badge.fury.io/py/ghcr-badge>\n) [](\n <https://results.pre-commit.ci/latest/github/eggplants/ghcr-badge/master>\n) [](\n <https://codeclimate.com/github/eggplants/ghcr-badge/maintainability>\n) [](\n <https://github.com/eggplants/ghcr-badge/actions/workflows/release.yml>\n)\n\n## Motivation\n\n<https://github.com/badges/shields/issues/5594>\n\n## Deployment\n\n[](\n <https://deta.space/discovery/@eggplants/ghcrbadge>\n)\n\n- <https://ghcr-badge.egpl.dev/>\n - [](https://ghcr-badge.egpl.dev)\n\n- <https://ghcr-badge.deta.dev/>\n - [](https://ghcr-badge.deta.dev)\n\n## Available paths\n\n- `/<package_owner>/<package_name>/tags?color=...&ignore=...&n=...&label=...&trim=...`\n - defaults: `color=#44cc11`, `ignore=latest`, `n=3`, `label=image tags`\n - <https://ghcr-badge.egpl.dev/eggplants/ghcr-badge/tags?trim=major>\n - \ud83d\udc49: ![1]\n- `/<package_owner>/<package_name>/latest_tag?color=...&ignore=...&label=...&trim=...`\n - defaults: `color=#44cc11`, `ignore=latest`, `label=version`\n - <https://ghcr-badge.egpl.dev/eggplants/ghcr-badge/latest_tag?trim=major&label=latest>\n - \ud83d\udc49: ![2]\n- `/<package_owner>/<package_name>/develop_tag?color=...&label=...`\n - defaults: `color=#44cc11`, `label=develop`\n - <https://ghcr-badge.egpl.dev/ptr727/plexcleaner/develop_tag>\n - \ud83d\udc49: ![3]\n- `/<package_owner>/<package_name>/size?color=...&tag=...&label=...&trim=...`\n - defaults: `color=#44cc11`, `tag=latest`, `label=image size`\n - <https://ghcr-badge.egpl.dev/eggplants/ghcr-badge/size>\n - \ud83d\udc49: ![4]\n\n## Common parameters\n\n### `label` parameter\n\n- `label=hello`: \n\n### `ignore` parameter\n\nUse the ignore parameter to filter returned tags, supports pattern matching and a comma separated list.\n\n- `ignore=latest` ignores the `latest` tag (default).\n- `ignore=sha256*` ignores all tags prefixed with `sha256`.\n- `ignore=v0.0.1,latest,sha256*` ignores the `latest` and `v0.0.1` tags, and all tags prefixed with `sha256*`.\n\n### `trim` parameter\n\n- `trim=patch` trims `^v?\\d+\\.\\d+\\.\\d+[^.]*$` tags.\n- `trim=major` trims `^v?\\d+\\.\\d+[^.]*$` tags.\n\n### `color` parameter\n\nAvailable color names and hex codes are listed on [here](https://github.com/jongracecox/anybadge#colors).\n\n## Note\n\nGenerated badge will be cached for 3666 seconds in GitHub's [Camo](https://github.com/atmos/camo) server.\nTo update immediately, send PURGE request to the badge Camo link.\n\n```bash\ncurl -X PURGE \"https://camo.githubusercontent.com/...\"\n```\n\n[1]: <https://ghcr-badge.egpl.dev/eggplants/ghcr-badge/tags?trim=major>\n[2]: <https://ghcr-badge.egpl.dev/eggplants/ghcr-badge/latest_tag?trim=major&label=latest>\n[3]: <https://ghcr-badge.egpl.dev/ptr727/plexcleaner/develop_tag>\n[4]: <https://ghcr-badge.egpl.dev/eggplants/ghcr-badge/size>\n\n## Development\n\n1. Install [`poetry`](https://python-poetry.org/docs/#installation)\n1. Run `poetry install && poetry shell && pre-commit install`\n1. Launch live server with `task dev`\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Generate ghcr.io container's status badge",
"version": "0.3.3",
"project_urls": {
"Homepage": "https://github.com/eggplants/ghcr-badge",
"Repository": "https://github.com/eggplants/ghcr-badge"
},
"split_keywords": [
"github-container-registry",
"badge",
"ghcr"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1ed736750a6be15233127e30ab2e6edcb246fceacbe85a20271222e6de683529",
"md5": "72b5755aa8231bf495f0c724324e0ab8",
"sha256": "a2cc04bc9ba7020900c39e4e43dff9f249604540fa25164f784856c44f9e5e5e"
},
"downloads": -1,
"filename": "ghcr_badge-0.3.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "72b5755aa8231bf495f0c724324e0ab8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<3.12",
"size": 56472,
"upload_time": "2023-08-03T14:35:31",
"upload_time_iso_8601": "2023-08-03T14:35:31.402740Z",
"url": "https://files.pythonhosted.org/packages/1e/d7/36750a6be15233127e30ab2e6edcb246fceacbe85a20271222e6de683529/ghcr_badge-0.3.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3fd419470c93a4de15824878ddef030ffb3f0d3a7d894873289efc50cb8125cd",
"md5": "5f6bea499c97790a3db0764f7573f026",
"sha256": "76a64d3fbbe24afccd3bd7ba80e96cb73ddf0493773d0971511043c0232025ea"
},
"downloads": -1,
"filename": "ghcr_badge-0.3.3.tar.gz",
"has_sig": false,
"md5_digest": "5f6bea499c97790a3db0764f7573f026",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<3.12",
"size": 57444,
"upload_time": "2023-08-03T14:35:32",
"upload_time_iso_8601": "2023-08-03T14:35:32.993426Z",
"url": "https://files.pythonhosted.org/packages/3f/d4/19470c93a4de15824878ddef030ffb3f0d3a7d894873289efc50cb8125cd/ghcr_badge-0.3.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-03 14:35:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "eggplants",
"github_project": "ghcr-badge",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ghcr-badge"
}
JSON
