An open API service indexing awesome lists of open source software.

https://github.com/gregoryam-sp/overviewer-repostats

Retrieves data from The Minecraft Overviewer repository.
https://github.com/gregoryam-sp/overviewer-repostats

data-scraping minecraft overviewer

Last synced: 2 months ago
JSON representation

Retrieves data from The Minecraft Overviewer repository.

Awesome Lists containing this project

README

        

### The Minecraft Overviewer Data (RepoStatistics)

The following data is used on [The Minecraft Overviewer Website](https://overviewer.gregoryam.com).

The GitHub Action uses GitHub API to pull the data from [The Minecraft Overviewer repository](https://github.com/gregoryam-sp/the-minecraft-overviewer) to update data on the website.

Which includes the following:

- The Release Tags
- The Release Assets
- The Release Asset URLs
- The Total Downloads for each Release
- The Total Amount of Forks for the Repository
- The Total Amount of Stars / Watchers for the Repository

Since I am unsure when the next release will be, I run a CRON job every 30 minutes to update the data. This will continue indefinitely.

Since I use GitHub Actions to complete the task of retrieving the data, the API Rate Limit is 5,000 per hour and we have 2,000 minutes per month.

Since the job is running every 30 minutes, I am using ~30.25% of my monthly 2,000 GitHub Action minutes. or approximately 605 minutes per month.

I also check the Rate Limit on every Action to make sure we are not going to hit the Rate Limit. Which you can check [here](https://github.com/GregoryAM-SP/Overviewer-RepoStats/actions)


You may review the data in the [data.json](https://github.com/GregoryAM-SP/Overviewer-RepoStats/blob/main/data.json) file.

You may also view the GitHub Action workflow in the [generate_json.yml](https://github.com/GregoryAM-SP/Overviewer-RepoStats/blob/main/.github/workflows/generate_json.yml) file to understand how the data is retrieved.

I use Python to retrieve the data from the GitHub API.