llnl / llnl/scraper

Redundant License Information (GitHub)

Open
#38 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
59
Forks
28
PR merge metrics
No merged PRs in 30d

Description

It looks like some amount of license information is manually maintained and provided by [`scraper/github/util.py`](https://github.com/LLNL/scraper/blob/49bad7c09677b5c45ddf22b3ccd2444bf5c1322e/scraper/github/util.py).

Complete license listings are readily available from GitHub and seem to make this script redundant.

via the REST API
https://api.github.com/licenses

or via the GraphQL API
```gql
{
licenses() {
spdxId
name
url
}
}
```

Perhaps we could re-write [`scraper/code_gov/models.py`](https://github.com/LLNL/scraper/blob/49bad7c09677b5c45ddf22b3ccd2444bf5c1322e/scraper/code_gov/models.py) and any other relevant code such that we wouldn't have to maintain these hard-coded mappings?

(Suggested in #37 )

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read scraper/github/util.py and scraper/code_gov/models.py, then inspect the GitHub REST /licenses endpoint and the GraphQL licenses query described in the issue. Trace other relevant license callers; the work is done when license listings no longer depend on manually maintained mappings.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, python
Domain
api, tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.