Is anyone downloading my releases - GitHub API Cheat Sheet

I migrated a repository from SourceForge to GitHub and wanted to see how many downloads were being done from GitHub.  SourceForge had a great UI for this.  GitHub does not.

GitHub has a REST API that you have to script against that provides information about releases and artifacts.

Need

I wanted to find out the number of downloads for a given release in a specific repository.

GitHub API 

GitHub API docs can be found here: https://developer.github.com/v3/  There is also v1, v2 APIs that in some cases are more different than evolutionary.

Releases

The releases of  portion of their API https://developer.github.com/v3/repos/releases/ . There is a bunch of stuff to parse through.

All releases for a given repository

Releases Documentation

This API will show you show you all the releases for a given repository..
  • https://api.github.com/repos/:owner/:repo/releases

Example 

You can see the release id at "id":

This is a subset of the returned data.  The release "id" can be used to retrieve individual packages in this release.  The following was returned by the GitHub API GET call above. Note the Name and id.
{
    "url": "https://api.github.com/repos/freemansoft/jacob-project/releases/31804607",
    "assets_url": "https://api.github.com/repos/freemansoft/jacob-project/releases/31804607/assets",
    "upload_url": "https://uploads.github.com/repos/freemansoft/jacob-project/releases/31804607/assets{?name,label}",
    "html_url": "https://github.com/freemansoft/jacob-project/releases/tag/Root_B-1_20",
    "id": 31804607,
    "node_id": "MDc6UmVsZWFzZTMxODA0NjA3",
    "tag_name": "Root_B-1_20",
    "target_commitish": "master",
    "name": "Release 1.20",
    "draft": false,

Information about a single release

Now we know our release id.  We can call the releases API to get the downloadable assets for that release.

Documentation 

Each release has a unique id.  I found the ID with the previous command.   The API returns the name, size and number of downloads and other information about each one of the assets.
  • https://api.github.com/repos/:owner/:repo/releases/:release_id

Example

Sample output

This release has several downloadable files/bundles. 

    "prerelease": false,
        "created_at": "2020-09-25T10:20:13Z",
            "published_at": "2020-09-25T09:57:24Z",
                "assets": [
                    {
                        "url": "https://api.github.com/repos/freemansoft/jacob-project/releases/assets/26181445",
                        "id": 26181445,
                        "node_id": "MDEyOlJlbGVhc2VBc3NldDI2MTgxNDQ1",
                        "name": "jacob-1.20.zip",
                        "label": null,
                        "uploader": {
                            "login": "freemansoft",
                            "id": 1217160,
                            "node_id": "MDQ6VXNlcjEyMTcxNjA=",
                            "avatar_url": "https://avatars1.githubusercontent.com/u/1217160?v=4",
                            "gravatar_id": "",
                            "url": "https://api.github.com/users/freemansoft",
                            "html_url": "https://github.com/freemansoft",
                            "followers_url": "https://api.github.com/users/freemansoft/followers",
                            "following_url": "https://api.github.com/users/freemansoft/following{/other_user}",
                            "gists_url": "https://api.github.com/users/freemansoft/gists{/gist_id}",
                            "starred_url": "https://api.github.com/users/freemansoft/starred{/owner}{/repo}",
                            "subscriptions_url": "https://api.github.com/users/freemansoft/subscriptions",
                            "organizations_url": "https://api.github.com/users/freemansoft/orgs",
                            "repos_url": "https://api.github.com/users/freemansoft/repos",
                            "events_url": "https://api.github.com/users/freemansoft/events{/privacy}",
                            "received_events_url": "https://api.github.com/users/freemansoft/received_events",
                            "type": "User",
                            "site_admin": false
                        },
                        "content_type": "application/x-zip-compressed",
                        "state": "uploaded",
                        "size": 506374,
                        "download_count": 41,
                        "created_at": "2020-09-25T10:22:34Z",
                        "updated_at": "2020-09-25T10:22:34Z",
                        "browser_download_url": "https://github.com/freemansoft/jacob-project/releases/download/Root_B-1_20/jacob-1.20.zip"
                    },
                    {
                        "url": "https://api.github.com/repos/freemansoft/jacob-project/releases/assets/26181444",
                        "id": 26181444,
                        "node_id": "MDEyOlJlbGVhc2VBc3NldDI2MTgxNDQ0",
                        "name": "jacob-1.20_src.zip",
                        "label": null,
                        "uploader": {
                            "login": "freemansoft",
                            "id": 1217160,
                            "node_id": "MDQ6VXNlcjEyMTcxNjA=",
                            "avatar_url": "https://avatars1.githubusercontent.com/u/1217160?v=4",
                            "gravatar_id": "",
                            "url": "https://api.github.com/users/freemansoft",
                            "html_url": "https://github.com/freemansoft",
                            "followers_url": "https://api.github.com/users/freemansoft/followers",
                            "following_url": "https://api.github.com/users/freemansoft/following{/other_user}",
                            "gists_url": "https://api.github.com/users/freemansoft/gists{/gist_id}",
                            "starred_url": "https://api.github.com/users/freemansoft/starred{/owner}{/repo}",
                            "subscriptions_url": "https://api.github.com/users/freemansoft/subscriptions",
                            "organizations_url": "https://api.github.com/users/freemansoft/orgs",
                            "repos_url": "https://api.github.com/users/freemansoft/repos",
                            "events_url": "https://api.github.com/users/freemansoft/events{/privacy}",
                            "received_events_url": "https://api.github.com/users/freemansoft/received_events",
                            "type": "User",
                            "site_admin": false
                        },
                        "content_type": "application/x-zip-compressed",
                        "state": "uploaded",
                        "size": 822795,
                        "download_count": 8,
                        "created_at": "2020-09-25T10:22:33Z",
                        "updated_at": "2020-09-25T10:22:34Z",
                        "browser_download_url": "https://github.com/freemansoft/jacob-project/releases/download/Root_B-1_20/jacob-1.20_src.zip"
                    },
                    {
                        "url": "https://api.github.com/repos/freemansoft/jacob-project/releases/assets/26181460",
                        "id": 26181460,
                        "node_id": "MDEyOlJlbGVhc2VBc3NldDI2MTgxNDYw",
                        "name": "README.md",
                        "label": null,
                        "uploader": {
                            "login": "freemansoft",
                            "id": 1217160,
                            "node_id": "MDQ6VXNlcjEyMTcxNjA=",
                            "avatar_url": "https://avatars1.githubusercontent.com/u/1217160?v=4",
                            "gravatar_id": "",
                            "url": "https://api.github.com/users/freemansoft",
                            "html_url": "https://github.com/freemansoft",
                            "followers_url": "https://api.github.com/users/freemansoft/followers",
                            "following_url": "https://api.github.com/users/freemansoft/following{/other_user}",
                            "gists_url": "https://api.github.com/users/freemansoft/gists{/gist_id}",
                            "starred_url": "https://api.github.com/users/freemansoft/starred{/owner}{/repo}",
                            "subscriptions_url": "https://api.github.com/users/freemansoft/subscriptions",
                            "organizations_url": "https://api.github.com/users/freemansoft/orgs",
                            "repos_url": "https://api.github.com/users/freemansoft/repos",
                            "events_url": "https://api.github.com/users/freemansoft/events{/privacy}",
                            "received_events_url": "https://api.github.com/users/freemansoft/received_events",
                            "type": "User",
                            "site_admin": false
                        },
                        "content_type": "application/octet-stream",
                        "state": "uploaded",
                        "size": 2617,
                        "download_count": 4,
                        "created_at": "2020-09-25T10:22:57Z",
                        "updated_at": "2020-09-25T10:22:57Z",
                        "browser_download_url": "https://github.com/freemansoft/jacob-project/releases/download/Root_B-1_20/README.md"
                    }
                ],
                    "tarball_url": "https://api.github.com/repos/freemansoft/jacob-project/tarball/Root_B-1_20",
                        "zipball_url": "https://api.github.com/repos/freemansoft/jacob-project/zipball/Root_B-1_20",
                            "body": "### What's New\r\n*   Upgraded from VS2015 to VS 2019\r\n*   Move from Sourceforge to GitHub\r\n*   Updated Junit jars\r\n*   VT_DATE and SafeArray\r\n### Tracked Changes\r\n| Item | Description |\r\n|-|-|\r\n| **Bugs**              | |\r\n|                   | none |\r\n| **Patches**           | |\r\n| 48                | Update to VS2019 Community and Windows 10 libs |\r\n| 1                 | Support VT_DATE getting from SafeArray |\r\n| **Feature Requests**  | |\r\n|                   | none |\r\n"
}

Future

This could use some kind of script that gathers all this information into a usable form.

Disclaimer

May not be of general interest. Is not complete.

Created 2020/10

Comments

Post a Comment

Popular posts from this blog

Installing the RNDIS driver on Windows 11 to use USB Raspberry Pi as network attached

Image
I do a lot of my development and configuration via ssh into my Raspberry Pi Zero over the RNDIS connection. Some models of the Raspberry PIs can be configured with  gadget drivers  that let the Raspberry pi emulate different devices when plugged into computers via USB. My favorite gadget  is the network profile that makes a Raspberry Pi look like an RNDIS-attached network device.  All types of network services travel over an RNDIS device without knowing it is a USB hardware connection. A Raspberry Pi shows up as a Remote NDIS (RNDIS) device when you plug the Pi into a PC or Mac via a USB cable. The gadget  in the Windows Device Manager picture shows this RNDIS Gadget connectivity between a Windows machine and a Raspberry Pi. The Problem Windows 11 and Windows 10 no longer auto-installs the RNDIS driver that makes magic happen. Windows recognizes that the Raspberry Pi is some type of generic USB COM device. Manually running W indows Update  or  Update Driver  does  not  install the RNDI
Read more

Understanding your WSL2 RAM and swap - Changing the default 50%-25%

Image
The Windows Subsystem for Linux operates as a virtual machine that can dynamically grow the amount of RAM to a maximum set at startup time.  Microsoft sets a default maximum RAM available to 50% of the physical memory and a swap-space that is 1/4 of the maximum WSL RAM.  You can scale those numbers up or down to allocate more or less RAM to the Linux instance. The first drawing shows the default WSL memory and swap space sizing. The images below show a developer machine that is running a dev environment in WSL2 and Docker Desktop.  Docker Desktop has two of its own WSL modules that need to be accounted for.  You can see that the memory would actually be oversubscribed, 3 x 50% if every VM used its maximum memory.  The actual amount of memory used is significantly smaller allowing every piece to fit. Click to Enlarge The second drawing shows the memory allocation on my 64GB laptop. WSL Linux defaults to a maximum RAM size of 5
Read more

Almost PaaS Document Parsing with Tika and AWS Elastic Beanstalk

Image
The Apache Tika project provides a  library capable of parsing and extracting data and meta data from over 1000 file types.  Tika is available as a single jar file that can be included inside applications or as a deployable jar file that runs Tika as a standalone service. This blog describes deploying the Tika jar as an auto-scale service in Amazon AWS Elastic Beanstalk.  I selected Elastic Beanstalk because it supports jar based deployments without any real Infrastructure configuration. Elastic Beanstalk auto-scale should take care of scaling up and down for for the number of requests you get. Tika parses documents and extracts their text completely in memory. Tika was deployed for this blog using EC2 t2.micro instances available in the AWS free tier. t2.micro VMs are 1GB which means that you are restricted in document complexity and size. You would size your instances appropriately for your largest documents.   Preconditions An AWS account. AWS access id and secret key.
Read more