github-stars-in-context / data-dictionary.json
mrshu's picture
Release v1.0.0
7e878b4 verified
Raw History Blame
11.1 kB
{
"collector_semantics": {
"classification_basis": "Code-inferred fetch outcome, not independent certification of current stored row-set completeness",
"empty_refresh_caveat": "update_user_repositories deletes obsolete rows only for a nonempty fetched list; a successful empty refresh can retain old rows",
"execution_history_caveat": "Provider identifies this collector; exact commands and logs still need confirmation",
"license_file_present": false,
"policy_id": "git-h-index-fe2d7196-v1",
"repository": "https://github.com/Pavloffm/git-h-index",
"revision": "fe2d7196f4fe305a7a42bb871d267a751f5513f8",
"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 omitted because the collector writes a constant zero, not an observed sponsorship count",
"excluded_source_fields": {
"repositories": [],
"user_links": [
"created_at",
"id",
"link_type",
"url",
"user_id"
],
"users": [
"bio",
"bio_length",
"company",
"following_count",
"links_parsed_at",
"location",
"organizations_count",
"sponsors_count"
]
},
"profile_rule": "NULL bio or ambiguous all-default signature implies unavailable analysis profile; raw counts are preserved separately",
"row_policy": "No stored source account/repository rows are dropped within the chosen full or sampled scope; code-inferred complete does not certify rowset completeness",
"source_sha256": "6feb097dfbcebbdbde2ba3bab24b65be7565b0eac6735dd28b7b86a1a31743c8",
"tables": {
"portfolios": {
"fields": [
{
"description": "Local owner key joining users.id",
"name": "user_id",
"nullable": true,
"type": "integer"
},
{
"description": "GitHub numeric owner identifier",
"name": "github_id",
"nullable": true,
"type": "integer"
},
{
"description": "All stored account-linked repository rows, including zero-star rows",
"name": "n_repositories",
"nullable": true,
"type": "integer"
},
{
"description": "Sum of stars over stored account-linked repository rows",
"name": "total_stars",
"nullable": true,
"type": "integer"
},
{
"description": "Largest stored repository star count; zero for an empty portfolio",
"name": "max_stars",
"nullable": true,
"type": "integer"
},
{
"description": "Exact integer sum of squared repository star counts",
"name": "sum_squared_stars",
"nullable": true,
"type": "integer"
},
{
"description": "h-index recomputed from descending stored star counts",
"name": "h_observed",
"nullable": true,
"type": "integer"
},
{
"description": "Stored users.h_index value",
"name": "h_stored",
"nullable": true,
"type": "integer"
},
{
"description": "Stored rows with at least one star",
"name": "starred_repositories",
"nullable": true,
"type": "integer"
},
{
"description": "Herfindahl concentration sum((stars/total_stars)^2), NULL at zero total",
"name": "concentration",
"nullable": true,
"type": "float"
},
{
"description": "Reciprocal Herfindahl concentration, NULL at zero total",
"name": "effective_breadth",
"nullable": true,
"type": "float"
},
{
"description": "Persisted account retrieval class",
"name": "retrieval_status",
"nullable": true,
"type": "string"
},
{
"description": "Conservative profile-availability analysis flag",
"name": "profile_available",
"nullable": true,
"type": "boolean"
},
{
"description": "Source passed prerequisite physical checks; not a completeness certificate",
"name": "valid_portfolio",
"nullable": true,
"type": "boolean"
},
{
"description": "Complete class under the declared code-inferred policy",
"name": "eligible",
"nullable": true,
"type": "boolean"
},
{
"description": "Class-based analysis exclusion, if any; rows remain in the release",
"name": "exclusion_reason",
"nullable": true,
"type": "string"
}
],
"rows": 3671497
},
"repositories": {
"fields": [
{
"description": "Local repository-row surrogate key",
"name": "id",
"nullable": true,
"type": "integer"
},
{
"description": "Local owner key joining users.id",
"name": "user_id",
"nullable": true,
"type": "integer"
},
{
"description": "GitHub numeric repository identifier; may occur under multiple owners",
"name": "repository_id",
"nullable": true,
"type": "integer"
},
{
"description": "Stored repository name; retained without rewriting",
"name": "name",
"nullable": true,
"type": "string"
},
{
"description": "GitHub repository createdAt on insertion, not retrieval time",
"name": "created_at",
"nullable": true,
"type": "string"
},
{
"description": "Stored nonnegative integer star count",
"name": "stars",
"nullable": true,
"type": "integer"
}
],
"rows": 53990808
},
"users": {
"fields": [
{
"description": "Local account surrogate key, not the GitHub owner ID",
"name": "id",
"nullable": true,
"type": "integer"
},
{
"description": "GitHub numeric owner identifier",
"name": "github_id",
"nullable": true,
"type": "integer"
},
{
"description": "Stored owner login, potentially different from its current login",
"name": "github_name",
"nullable": true,
"type": "string"
},
{
"description": "Collector account-row insertion timestamp, not GitHub registration time",
"name": "created_at",
"nullable": true,
"type": "string"
},
{
"description": "Shared collector/profile/link stage timestamp or failure sentinel, not repository observation time",
"name": "last_updated",
"nullable": true,
"type": "string"
},
{
"description": "Stored source h-index, independently recomputed in portfolios",
"name": "h_index",
"nullable": true,
"type": "integer"
},
{
"description": "Unchanged raw collector flag, including negative values",
"name": "repositories_fetched",
"nullable": true,
"type": "integer"
},
{
"description": "Analysis value, NULL where the conservative profile-availability rule masks raw defaults",
"name": "followers_count",
"nullable": true,
"type": "integer"
},
{
"description": "Unchanged raw source follower count, including collection defaults",
"name": "followers_count_raw",
"nullable": true,
"type": "integer"
},
{
"description": "Persisted collector-inferred class or explicit sidecar override; not independent rowset certification",
"name": "retrieval_status",
"nullable": true,
"type": "string"
},
{
"description": "Conservative analysis availability flag, not proof that a profile request succeeded",
"name": "profile_available",
"nullable": true,
"type": "boolean"
},
{
"description": "Whether the source bio was NULL; the bio text is excluded",
"name": "bio_was_null",
"nullable": true,
"type": "boolean"
},
{
"description": "Whether the source matched the conservative all-default profile signature",
"name": "profile_default_signature",
"nullable": true,
"type": "boolean"
},
{
"description": "Classification basis recorded by the pinned collector helper",
"name": "retrieval_inference_basis",
"nullable": true,
"type": "string"
},
{
"description": "Collector source-code reference or explicit record-level evidence reference",
"name": "retrieval_evidence_ref",
"nullable": true,
"type": "string"
},
{
"description": "False: code-inferred completion does not independently certify stored rows",
"name": "rowset_completeness_independently_certified",
"nullable": true,
"type": "boolean"
}
],
"rows": 3671497
}
},
"timestamp_semantics": {
"repositories.created_at": "GitHub repository createdAt retained on insertion, not fetch time (github_parser.py:30-34; database.py:94-105)",
"user_links.created_at": "Link-row timestamp; collector write path must be cited, not repository observation time",
"users.created_at": "Discovery insertion datetime.now(), not GitHub registration (popular_users.py:168-176)",
"users.last_updated": "Overloaded: user refresh/profile-enrichment time or failure sentinel, with parse_all reset; not repository observation time (database.py:41-67,243-252; fetch_user_profile.py:115-145; main.py:89-99)",
"users.links_parsed_at": "Link parsing stage timestamp; not repository observation time (database.py link parsing writers)"
},
"views": {
"identifier_crosswalk": {
"definition_file": "crosswalk.sql",
"materialized": false,
"url_meaning": "Constructed from stored owner/login and repository name, not verified as current"
}
}
}