github-stars-in-context / data-dictionary.json
mrshu's picture
Release 1.1.0: add release.json and the rewritten data dictionary
15eb06e verified
Raw History Blame Contribute Delete
11.1 kB
{
"collector_semantics": {
"repository": "https://github.com/NaiveNeuron/github-stars-in-context/tree/main/collector",
"license": "MIT",
"revision": "fe2d7196f4fe305a7a42bb871d267a751f5513f8",
"policy_id": "git-h-index-fe2d7196-v1",
"classification_basis": "Classes are derived from the collector's stored flags. They were not checked against GitHub",
"empty_refresh_caveat": "The collector deletes obsolete rows only when a refresh returns at least one repository. A successful empty refresh can leave older rows in place",
"execution_history": "Run logs were not kept. PROVENANCE.md in the code repository records what is known",
"source_file_sha256": {
"config.py": "395feea85c2bc1ca64eddc6942c8c8e7bdb52bf5f1edc3fc648833d888e422ef",
"data_fetching/github_parser.py": "5e11db0afccf4e48bb9ec922ee59f1b283361ebc5eab116ef5ced035bb3016e8",
"data_fetching/main.py": "5fbf439f342c33247cd2d9fa274d2746da5943b2f2fad5ffa8a6fcc7c90f6d72",
"data_fetching/users_fetching/fetch_user_links.py": "d23999eb87985b6b444431a9585917aae6b905b8ffb6dc715c6463235feb7a98",
"data_fetching/users_fetching/fetch_user_profile.py": "1efce9b500f5a581f73e0603ce25e0c751c260b5b7733218c6cf1872ca8aea5b",
"data_fetching/users_fetching/popular_users.py": "a4ca76eeb6c5338f648a398ff0dfe72db8b69782863fe7b22cb142fcedbdbe73",
"data_storage/database.py": "ed5ca3e99ce6826cea7ef679a609ef2a0dc3dde3f8e1e913c90d28425869e3b3"
}
},
"constant_sponsorship": "sponsors_count is not released because the collector stored 0 for every account",
"excluded_source_fields": {
"repositories": [],
"user_links": "whole table",
"users": [
"bio",
"bio_length",
"company",
"following_count",
"links_parsed_at",
"location",
"organizations_count",
"sponsors_count"
]
},
"profile_rule": "profile_available is false when the stored biography is NULL or all stored profile fields have their default values. followers_count is then NULL and the stored value is kept in followers_count_raw",
"row_policy": "Every stored account and repository row of the source database is released. The complete class does not certify that an account's repository list is complete",
"source_sha256": "6feb097dfbcebbdbde2ba3bab24b65be7565b0eac6735dd28b7b86a1a31743c8",
"tables": {
"portfolios": {
"fields": [
{
"description": "Local key of the account. Joins users.id",
"name": "user_id",
"nullable": true,
"type": "integer"
},
{
"description": "GitHub's numeric ID of the account",
"name": "github_id",
"nullable": true,
"type": "integer"
},
{
"description": "Number of stored repository rows of the account, including repositories with no stars",
"name": "n_repositories",
"nullable": true,
"type": "integer"
},
{
"description": "Sum of stars over those rows",
"name": "total_stars",
"nullable": true,
"type": "integer"
},
{
"description": "Largest star count among those rows. 0 for an account with no rows",
"name": "max_stars",
"nullable": true,
"type": "integer"
},
{
"description": "Sum of squared star counts over those rows",
"name": "sum_squared_stars",
"nullable": true,
"type": "integer"
},
{
"description": "h-index recomputed from the repository rows",
"name": "h_observed",
"nullable": true,
"type": "integer"
},
{
"description": "h-index stored by the collector (users.h_index)",
"name": "h_stored",
"nullable": true,
"type": "integer"
},
{
"description": "Number of rows with at least one star",
"name": "starred_repositories",
"nullable": true,
"type": "integer"
},
{
"description": "Sum of squared star shares (Herfindahl index). NULL when total_stars is 0",
"name": "concentration",
"nullable": true,
"type": "float"
},
{
"description": "1 / concentration. NULL when total_stars is 0",
"name": "effective_breadth",
"nullable": true,
"type": "float"
},
{
"description": "Same as users.retrieval_status",
"name": "retrieval_status",
"nullable": true,
"type": "string"
},
{
"description": "Same as users.profile_available",
"name": "profile_available",
"nullable": true,
"type": "boolean"
},
{
"description": "True when the account's rows passed the structural checks. It says nothing about completeness",
"name": "valid_portfolio",
"nullable": true,
"type": "boolean"
},
{
"description": "True when retrieval_status is complete. The reuse examples use these accounts",
"name": "eligible",
"nullable": true,
"type": "boolean"
},
{
"description": "Why the account is left out of the reuse examples. NULL for accounts that are used. All rows stay in the release",
"name": "exclusion_reason",
"nullable": true,
"type": "string"
}
],
"rows": 3671497
},
"repositories": {
"fields": [
{
"description": "Local key of the row",
"name": "id",
"nullable": true,
"type": "integer"
},
{
"description": "Local key of the owner. Joins users.id",
"name": "user_id",
"nullable": true,
"type": "integer"
},
{
"description": "GitHub's numeric ID of the repository. Twenty IDs appear under more than one account",
"name": "repository_id",
"nullable": true,
"type": "integer"
},
{
"description": "Repository name as stored",
"name": "name",
"nullable": true,
"type": "string"
},
{
"description": "Creation time of the repository on GitHub. Not the time it was fetched",
"name": "created_at",
"nullable": true,
"type": "string"
},
{
"description": "Star count when the repository was fetched",
"name": "stars",
"nullable": true,
"type": "integer"
}
],
"rows": 53990808
},
"users": {
"fields": [
{
"description": "Local key of the account in this dataset. Not the GitHub ID",
"name": "id",
"nullable": true,
"type": "integer"
},
{
"description": "GitHub's numeric ID of the account",
"name": "github_id",
"nullable": true,
"type": "integer"
},
{
"description": "Login stored at collection time. The account may have been renamed since",
"name": "github_name",
"nullable": true,
"type": "string"
},
{
"description": "Time the collector inserted the account (8 or 9 December 2025). Not the GitHub registration date",
"name": "created_at",
"nullable": true,
"type": "string"
},
{
"description": "Time of the collector's last update of the account, or the placeholder 6200-01-01. Not the time the repositories were fetched",
"name": "last_updated",
"nullable": true,
"type": "string"
},
{
"description": "h-index stored by the collector. portfolios.h_observed recomputes it from the repository rows",
"name": "h_index",
"nullable": true,
"type": "integer"
},
{
"description": "Raw collector flag: 1 after a repository fetch ended, -1 while one was in progress",
"name": "repositories_fetched",
"nullable": true,
"type": "integer"
},
{
"description": "Follower count. NULL when profile_available is false",
"name": "followers_count",
"nullable": true,
"type": "integer"
},
{
"description": "Follower count as stored. When profile_available is false it is a default value, not an observed count",
"name": "followers_count_raw",
"nullable": true,
"type": "integer"
},
{
"description": "Repository retrieval class derived from the collector's flags: complete, failed or unknown. Not checked against GitHub",
"name": "retrieval_status",
"nullable": true,
"type": "string"
},
{
"description": "False when the stored biography is NULL or all stored profile fields are defaults. The follower count is then treated as missing",
"name": "profile_available",
"nullable": true,
"type": "boolean"
},
{
"description": "True when the stored biography was NULL. The biography text is not released",
"name": "bio_was_null",
"nullable": true,
"type": "boolean"
},
{
"description": "True when the stored profile fields all had their default values",
"name": "profile_default_signature",
"nullable": true,
"type": "boolean"
},
{
"description": "How retrieval_status was derived. Always collector_code_inference",
"name": "retrieval_inference_basis",
"nullable": true,
"type": "string"
},
{
"description": "Location in the collector source that supports the class",
"name": "retrieval_evidence_ref",
"nullable": true,
"type": "string"
},
{
"description": "Always false. No account's repository list was checked against GitHub",
"name": "rowset_completeness_independently_certified",
"nullable": true,
"type": "boolean"
}
],
"rows": 3671497
}
},
"timestamp_semantics": {
"users.created_at": "Time the collector inserted the account (8 or 9 December 2025). Not the GitHub registration date",
"users.last_updated": "Time of the collector's last update of the account, or the placeholder 6200-01-01. Not the time the repositories were fetched",
"repositories.created_at": "Creation time of the repository on GitHub. Not the time it was fetched"
},
"views": {
"identifier_crosswalk": {
"definition_file": "crosswalk.sql",
"materialized": false,
"url_meaning": "URLs are built from the stored login and repository name. They were not checked against GitHub"
}
},
"version": "1.1.0"
}