openedx / openedx/XBlock

startnew.py should be installed as a script

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

Nobody has claimed this yet.

Dominant language
Python
Stars
470
Forks
231
Avg merge
1d 1h
Merged PRs (30d)
6

Description

From PR #147:

Not for this PR, but we should use the console_scripts entry point to just install the startnew script into the virtualenv when you install xblocks. That way, in the future, you'll just be able to pip install XBlock && start_xblock, or something similar.

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 reading startnew.py and the project's Python packaging configuration, then check how console_scripts entry points are declared. Confirm how xblocks is installed and what command name should invoke the script. Done means installing XBlock in a virtual environment makes the script available as a command without manually locating startnew.py.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, cli
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.