Update README to reflect PyPI usage #201
Conversation
| ``` | ||
| pip install xblock-problem-builder |
There was a problem hiding this comment.
@bradenmacdonald CC @jmbowman I get an error when I run this:
(venv) $ pip install xblock-problem-builder==3.1.3
Collecting xblock-problem-builder==3.1.3
Using cached https://files.pythonhosted.org/packages/d5/5d/12eb466347984534705efceed7da59883df004a1ce71f4d04b9fa51f1191/xblock_problem_builder-3.1.3-py2-none-any.whl
Collecting XBlock (from xblock-problem-builder==3.1.3)
Using cached https://files.pythonhosted.org/packages/71/8e/cd778ea775fee0badffa33cfaa908dbd341c06aaf73cc70d9b5d930b4925/XBlock-1.2.1.tar.gz
Collecting xblock-utils (from xblock-problem-builder==3.1.3)
Could not find a version that satisfies the requirement xblock-utils (from xblock-problem-builder==3.1.3) (from versions: )
No matching distribution found for xblock-utils (from xblock-problem-builder==3.1.3)
And sure enough, pypi.org doesn't have an xblock-utils package as requested by setup.py, it's called xblock-openedx-utils instead!
There was a problem hiding this comment.
@pomegranited edX actually doesn't publish xblock-utils to PyPI. That seems to be something posted by Stanford years ago and it's out of date (v0.9.0 vs 1.1.1). It seems that edX installs xblock-utils from git
So I think for now we should just merge this anyways and consider it a non-pip-installable prereq. Any edx-platform virtualenv will already have xblock-utils installed anyways.
CC @jmbowman in case you have any input.
There was a problem hiding this comment.
@bradenmacdonald Huh, ok! So could we instead remove the install_requires reference to xblock-utils from setup.py?
Or change the docs to note that this should only be installed in an edx-platform virtualenv?
There was a problem hiding this comment.
Well it is still a requirement, so I don't want to remove it. I have updated the README to explain that in 6d62e61
There was a problem hiding this comment.
👍 Thanks for adding that @bradenmacdonald -- looks good now.
- I tested this in my open edx devstack using the updated instructions.
- I read through the code
-
I checked for accessibility issues - Includes documentation updates
| ``` | ||
| pip install xblock-problem-builder |
Follow up to #199 to update the docs accordingly.