opensafely-core / opensafely-core/osgithub

Archive osgithub by moving required code into Reports and Actions Registry

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

Nobody has claimed this yet.

Dominant language
Python
Stars
0
Forks
0
Avg merge
2d 20h
Merged PRs (30d)
9

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 osgithub as a dependency from both applications.
  • Archive osgithub repository on GitHub
  • Archive osgithub package on PyPI

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

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.

Assessment

Tech stack
python
Domain
api, backend
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.