Fold this repo into XBlock
Open
Nobody has claimed this yet.
code health
- Dominant language
- JavaScript
- Stars
- 70
- Forks
- 104
- Avg merge
- 17h 46m
- Merged PRs (30d)
- 14
Description
This repository is useful to XBlock developers, and it is tightly coupled to XBlock. So, let's merge it into the XBlock repository.
Considerations:
- It should be isolated to a sub-directory and have its own requirements file. The requirements file should be available via
extras-require. This way, edx-platform can runpip install xblock[django](so that it doesn't pull in sdk dev tool packages) and developers can runpip install xblock[sdk].- We don't have a paved path for this setup, so this will take some creativity. repo-tools does a more complicated version of this: it has EXTRAS_REQUIRE defined for every subdirectory with requirements. We don't need to go that far, but the example might be helpful.
Contributor guide
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.
Research direction
Start by comparing this repository with the XBlock repository and inspect repo-tools/setup.py, especially its EXTRAS_REQUIRE handling. Define how this repository can live in an isolated subdirectory with its own requirements file and be exposed through xblock[sdk] without pulling SDK development tools into xblock[django]. Done means the repositories are merged and both extras install the intended dependencies.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- build-system
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100