Skip to content

A tool to download REST API data from GitHub repositories into a local SQL database

License

Notifications You must be signed in to change notification settings

gnoverse/gh-sql

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

gh-sql

GitHub SQL is a tool to fetch data from the GitHub API and store it in a SQL database. The ultimate goal is to have the data locally to perform queries on the dataset.

The tool has the following focuses:

  • Being targeted towards storing information about specific repositories.
    • Discovery of users or repositories is a non-goal.
  • Being able to incrementally update the database, fetching what has changed in a repository using the events API (either through polling, even in long intervals (up to 1 month) or through WebSockets).
  • Being able to easily "saved" in a single SQL file for quick recovery and replication.
  • Replicating the GitHub REST API in read-only operations, without rate limiting (for integration with existing tools that use the GitHub API, by only changing the API endpoint.)

Check out the cookbook for some more examples.

Status

Still pretty heavily work in progress, and I won't make migration strategies, so feel free to build up a database knowing that it'll likely have to be re-created from scratch when this gets updated.

About

A tool to download REST API data from GitHub repositories into a local SQL database

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published