Skip to content

README.md

Latest commit

 

History

History
44 lines (41 loc) · 2.8 KB

README.md

File metadata and controls

44 lines (41 loc) · 2.8 KB

Extracting object-centric event data from GitHub repositories

Getting started

  1. Create a personal GitHub access token. Instructions can be found here: GitHub Docs - Creating a personal access token (classic)
  2. Save this access token in config.py. It will be used to connect to the GitHub REST API.
  3. In script.py, define from which repository the event data will be extracted and how many issues (this includes pull requests) should be fetched.
  4. In script.py, define where the data should be stored.
  5. Run python3 ../github_logs/script.py.

Sidenote: If you get an list index out of range error, make sure you are using a repository with issues.

What data is included?

This part of the Stack't project is still in active development. A list of what kind of data is extracted is given below and will be kept up-to-date.

  • object types:
    • issue (this includes both pull requests and issues)
    • user (GitHub user accounts + persons who made commits)
      • Note that commits are often not linked to a GitHub user account. In that case, the name of the committer is used instead of the unique user id. It's therefore possbile that the same person has multiple user objects associated to it.
    • team (GitHub team)
    • commit
  • object attributes:
    • issue: number, title, timeline_url
    • user: id, login, type, url (= html url)
      • Note that "committers" don't have any attributes.
    • team: slug, name, privacy, url (= html url)
    • commit: sha (= unique id), commit_message, url (= html url)
  • event types:
  • event attributes:
    • author_association (if available in API response)
  • event-to-object relations:
    • created-to-issue: created
    • created-to-user: created by
    • timeline_event-to-user: actor (user that did the action) Note: not available yet for event type committed.
    • review_requested/review_request_removed-to-user: requested_reviewer
    • review_requested/review_request_removed-to-team: requested_team
    • assigned/unassigned-to-user: assignee
    • comitted-to-commit: comitted
  • object-to-object relations:
    • issue-to-user: created by
    • issue-to-user: requested_reviewer (dynamic, set to null when review_request_removed)
    • issue-to-team: requested_team (dynamic, set to null when review_request_removed)
    • issue-to-user: assignee (dynamic, set to null when unassigned)
    • commit-to-user: committer