Archive osgithub by moving required code into Reports and Actions Registry
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
Research direction
Start by identifying the current osgithub consumers in Reports and Actions Registry and documenting which functionality each application requires. Move the required code into both applications, remove the dependency, then verify the repositories and PyPI package can be archived as specified by the checklist.
Written by the indexing model from the issue text.
Description
Description
osgithub was originally intended to provide a generic shared interface for interacting with the GitHub API. But in reality, we've had very different use cases each time we've wanted to get something from GitHub. Consequently, we've only used the osgithub library in two places - Reports and Actions Registry. Maintaining osgithub as a separate library now creates overhead that may not be justified by its limited reuse.
We should investigate and migrate the required osgithub functionality directly into the two applications that currently depend on it, and then archive the osgithub repository.
Related slack discussion.
How will we know when it's done?
- Identify all current consumers of
osgithub. - Move the required code into
Reports. - Move the required code into
Actions Registry. - Remove
osgithubas a dependency from both applications. - Archive
osgithubrepository on GitHub - Archive
osgithubpackage on PyPI
- Dominant language
- Python
- Stars
- 0
- Forks
- 0
- Avg merge
- 2d 20h
- Merged PRs (30d)
- 9
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from opensafely-core/osgithub
-
dependency-management
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
opensafely-core/osgithub#289 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 52/100
opensafely-core/osgithub#242 ·
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
opensafely-core/osgithub#236 ·
-
Difficulty 5/5 Over a week Newbie friendliness 30/100
opensafely-core/osgithub#230 · 1 comment ·
-
Difficulty 4/5 3-5 days Newbie friendliness 32/100
opensafely-core/osgithub#142 ·
All issues in opensafely-core/osgithub
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
stephrobert/dsoxlab#238 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
sublimehq/package_control#1780 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
nwg-piotr/nwg-displays#145 ·