openedx / openedx/xblock-sdk

Fold this repo into XBlock

Open
#419 1 comment 0 reactions 0 assignees View on GitHub

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 run pip install xblock[django] (so that it doesn't pull in sdk dev tool packages) and developers can run pip install xblock[sdk].

Contributor guide

Open the contributing guide

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 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.