Commit b406a70f by Albert (AJ) St. Aubin Committed by GitHub

Merge pull request #13148 from edx/aj/TNL-4950_xBlockCounts

Added documentation and example json file
parents c5434c53 87538185
## XBlocks count script
The script in this directory, xblock_counts.py, when run will produce 2 csv files containing a summary
of the XBlock usage in courses.
This script requires a list of XBlock types. The xblock_studio_configuration.json file included is an example. The file
contains a list of types for the tool to summarize with counts.
{
"data": [
{
"name": "problem",
},
{
"name": "video",
},
...
]
}
### Steps for usage
1. Ensure all python requirements are up to date including those listed in the requirements.txt file.
2. Request a OAUTH2_Client ID on the api platform you are querying.
3. Execute the command line to run the script.
### Example command line usage
python xblock_counts.py -u <email> -p <password> -c <OAUTH2 Client_id> -m 12 -x xblock_studio_configuration.json -a https://courses.edx.org
Use python xblock_counts.py -h to get a list of command line options.
{
"data": [
{
"name": "audio",
},
{
"name": "discussion",
},
{
"name": "done",
},
{
"name": "drag-and-drop-v2",
},
{
"name": "html",
},
{
"name": "poll",
},
{
"name": "problem",
},
{
"name": "survey",
},
{
"name": "video",
},
]
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment