https://github.com/ipitio/backage
Endpoint behind badges for GitHub Packages
https://github.com/ipitio/backage
api automation docker ghcr github-actions gnu-parallel gradle json2xml maven monitoring npm nuget proxy rubygems scraper time-series yq
Last synced: about 1 month ago
JSON representation
Endpoint behind badges for GitHub Packages
- Host: GitHub
- URL: https://github.com/ipitio/backage
- Owner: ipitio
- License: mit
- Created: 2024-06-08T09:11:40.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2026-01-22T13:16:09.000Z (about 2 months ago)
- Last Synced: 2026-01-22T16:59:09.066Z (about 2 months ago)
- Topics: api, automation, docker, ghcr, github-actions, gnu-parallel, gradle, json2xml, maven, monitoring, npm, nuget, proxy, rubygems, scraper, time-series, yq
- Language: Shell
- Homepage: https://ipitio.github.io/backage/
- Size: 799 MB
- Stars: 48
- Watchers: 0
- Forks: 14
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/ipitio/backage)
# [backage](https://github.com/ipitio/backage)
**It's all part and parcel**
---
[](https://github.com/ipitio/backage/tree/index) [](https://github.com/ipitio/backage/releases/latest)
[](https://github.com/ipitio/backage/pkgs/container/backage) [](https://github.com/ipitio/backage/pkgs/container/backage) [](https://github.com/ipitio/backage/pkgs/container/backage) [](https://github.com/ipitio/backage/pkgs/container/backage)
Ever wish you could show npm, gem, mvn, Gradle, NuGet, or GHCR badges for GitHub Packages? Or just query for the download counts? This endpoint makes that possible, using only free GitHub resources; the API doesn't, and has never, exposed the public metadata that other registries provide.
## Getting Started
If this is [`ipitio/backage`](https://github.com/ipitio/backage), all you have to do is **star the repo to get your public packages added!** The service's circular priority queue will update the [closed-loop system](https://github.com/ipitio/backage/releases/latest) with them within the next few hours. Additionally watching and forking the repo, and following the owner, are ways to increase their priority. Yes, I know, but these are the graphs GitHub has available.
> [!WARNING]
> Ensure your profile is [public](https://github.com/ipitio/backage/issues/34#issuecomment-2968850773) so that this repo can see your packages.
Otherwise, if this is a fork, you'd prefer an alternative method, or your packages weren't added to the [index](https://github.com/ipitio/backage/tree/index) after a day, enter the case-sensitive name of each missing user or organization on a new line at the top of the queue, `owners.txt`, [here](https://github.com/ipitio/backage/edit/master/owners.txt) and make a pull request. Don't worry -- while my Contribution Graph is an uptime monitor of sorts, yours won't be. See the top of `bkg.sh` for details about available options, which must come last when passed to `update.sh`, as shown in `Self-Host` below.
> [!TIP]
> You only need to add names to the queue; IDs are fetched as needed and entries are removed once processed.
New packages won't be added until *all* existing ones are refreshed; you should also create an independent instance that'll update faster and more frequently. Simply fork just the `master` branch, choose one of the following options, and use the [Alternative URL](#alternative-url) when it changes. This centralized repo will then serve as a backup for all subsets of packages not in `optout.txt`.
> [!IMPORTANT]
> Your own packages will be picked up automatically! If you need to edit `owners.txt`, do so after the first run.
With Actions
This will use a lot of minutes on GitHub-hosted runners, so you may want to use your own.
1. Enable Actions from its tab
2. Enable all disabled workflows
Self-Host
This is an example for `systemd`; adapt it to your needs. Please note:
- Docker needs to be installed
- You don't need to set `GITHUB_TOKEN` if you first log in with `gh`
- `-m 0` ensures only the public packages of the owners you've added are updated (default)
- You'll need the proper permissions to update private packages
- `-d 0` allows everything to be updated in one go
- A graceful restart is initiated every 4 hours by default
```bash
echo "[Unit]
Description=Run Backage
After=network.target
StartLimitIntervalSec=0
[Service]
Type=simple
Restart=always
RestartSec=5
ExecStart=/usr/bin/sh -c ' \\
GITHUB_TOKEN= ;\\
GITHUB_OWNER= ;\\
GITHUB_REPO=backage ;\\
GITHUB_BRANCH=master ;\\
BKG_PATH=\$GITHUB_REPO/\$GITHUB_BRANCH ;\\
mkdir -p /opt/\$BKG_PATH ;\\
docker run -v /opt/\$BKG_PATH:/app \\
--env-file <(env | grep GITHUB) \\
ghcr.io/\$GITHUB_OWNER/\${BKG_PATH////:} \\
src/test/update.sh -m 0 -d 0'
[Install]
WantedBy=multi-user.target
" | sudo tee /etc/systemd/system/bkg.service
sudo systemctl daemon-reload
sudo systemctl enable --now bkg
```
## The Endpoint
```py
https://ipitio.github.io/backage/OWNER/[REPO/[PACKAGE]].FORMAT
```
Once the packages you're interested in have been added, replace the parameters with their respective values, scoping to your parsing needs, then access the latest data however you want. The format can be either `json` or `xml`.
> [!NOTE]
> Use something like [shields.io/json](https://shields.io/badges/dynamic-json-badge) or [shields.io/xml](https://shields.io/badges/dynamic-xml-badge) to make badges like [this one](https://github.com/badges/shields/issues/5594#issuecomment-2157626147). You'll need the latter to evaluate expressions, like filters ([issue](https://github.com/ipitio/backage/issues/23)).
### Available Properties
Package
| Property | Type | Description |
| :-------------------: | :----------: | ------------------------------------------------------- |
| `owner_id` | number | The ID of the owner |
| `owner_type` | string | The type of owner (e.g. `users`) |
| `package_type` | string | The type of package (e.g. `container`) |
| `owner` | string | The owner of the package |
| `repo` | string | The repository of the package |
| `package` | string | The package name |
| `date` | string | The most recent date the package was refreshed |
| `size` | string | Formatted size of the latest version |
| `versions` | string | Formatted count of all versions recently tracked |
| `tagged` | string | Formatted count of all tagged versions recently tracked |
| `owner_rank` | string | Formatted rank by downloads within the owner |
| `repo_rank` | string | Formatted rank by downloads within the repository |
| `downloads` | string | Formatted count of all downloads |
| `downloads_month` | string | Formatted count of all downloads in the last month |
| `downloads_week` | string | Formatted count of all downloads in the last week |
| `downloads_day` | string | Formatted count of all downloads in the last day |
| `raw_size` | number | Size of the latest version, in bytes |
| `raw_versions` | number | Count of versions ever tracked |
| `raw_tagged` | number | Count of tagged versions ever tracked |
| `raw_owner_rank` | number | Rank by downloads within the owner |
| `raw_repo_rank` | number | Rank by downloads within the repository |
| `raw_downloads` | number | Count of all downloads |
| `raw_downloads_month` | number | Count of all downloads in the last month |
| `raw_downloads_week` | number | Count of all downloads in the last week |
| `raw_downloads_day` | number | Count of all downloads in the last day |
| `version` | object array | The versions of the package (see below) |
Version
| Property | Type | Description |
| :-------------------: | :----------: | ---------------------------------------------- |
| `id` | number | The ID of the version |
| `name` | string | The version name |
| `date` | string | The most recent date the version was refreshed |
| `newest` | boolean | Whether the version is the newest |
| `latest` | boolean | Whether the version is the newest tagged |
| `size` | string | Formatted size of the version |
| `downloads` | string | Formatted count of downloads |
| `downloads_month` | string | Formatted count of downloads in the last month |
| `downloads_week` | string | Formatted count of downloads in the last week |
| `downloads_day` | string | Formatted number of downloads in the last day |
| `raw_size` | number | Size of the version, in bytes |
| `raw_downloads` | number | Count of downloads |
| `raw_downloads_month` | number | Count of downloads in the last month |
| `raw_downloads_week` | number | Count of downloads in the last week |
| `raw_downloads_day` | number | Count of downloads in the last day |
| `tags` | string array | The tags of the version |
### Query Syntax
JSON
You can query a package for its properties, like size or version:
```js
$.PROPERTY
```
```js
$.size
```
Versions may be filtered in and tags out:
```js
$.version[FILTER].PROPERTY
```
```js
$.version[?(@.latest)].tags[?(@!="latest")]
```
As can packages in `owner[/repo]/.json` files:
```js
$.[FILTER].PROPERTY
```
XML
You can query a package for its properties, like size or version:
```py
//PROPERTY
```
```py
//size
```
Versions can be filtered in and tags out:
```py
//version[FILTER]/PROPERTY
```
```py
//version[./latest[.="true"]]/tags[.!="latest"]
```
As can packages in `owner[/repo]/.xml` files:
```py
//package[FILTER]/PROPERTY
```
### Alternative URL
```py
https://github.com/ipitio/backage/raw/index/OWNER/[REPO/[PACKAGE]].FORMAT
```
The endpoint is also available here! This will change to your fork once it updates.
## Bring Your Own JSON
```py
https://ipitio.github.io/backage?json=https://URL/ENCODED/JSON
```
While this doesn't directly work with Shields, you can BYOJ to convert into XML. Try it out in your browser:
****