GitHub Hacktoberfest Statistics

ETL pipeline for statistical analysis of Hacktoberfest contributions to GitHub (on a tight budget)

• Regularly between YYYY-09-30-10:00:00 and YYYY-11-01-14:00:00 UTC for
  • created PRs
  • accepted PRs
• Accepted PRs are
  • valid
  • between YYYY-09-30-10:00:00 and YYYY-11-01-14:00:00 UTC
  • either
    • merged, or
    • open and labeled with hacktoberfest-accepted
• Valid PRs are
  • to repositories with the hacktoberfest topic or have the hacktoberfest-accepted label
  • created between YYYY-09-30-10:00:00 and YYYY-11-01-14:00:00 UTC
  • not labeled either spam or invalid iff also not labelled hacktoberfest-accepted
  • not a draft PR
• Excludes PR review acceptance criteria on assumption of being met if the PR is approved
• Excludes PRs created by bots
• Does not account for PR disqualification aside for PR labels spam and invalid
• Assumes included repositories meet other requirements to be valid for Hacktoberfest
  • includes fork repos, owned by PR creators or not, assuming they qualify for Hacktoberfest
  • accepted PR data for repos removed following API-fetching remain included in the statistics

Install

pip install -r requirements.txt

Test

python -m pytest [--cov]

Run

For orchestration, refer to: Hacktoberfest-Stats/hacktoberfest-stats-tap

ETL Pipeline

python hack_stats_etl_pipeline.py [OPTIONS]

Run with --help to see available options.

Update DB

python hack_stats_db_update.py [OPTIONS]

Run with --help to see available options.

Examples