Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/connor-makowski/edx_pygration
A repo to help with the pygration from 2 > 3
https://github.com/connor-makowski/edx_pygration
Last synced: about 2 months ago
JSON representation
A repo to help with the pygration from 2 > 3
- Host: GitHub
- URL: https://github.com/connor-makowski/edx_pygration
- Owner: connor-makowski
- Created: 2020-06-04T21:15:58.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-06-22T03:19:27.000Z (over 2 years ago)
- Last Synced: 2023-03-02T23:26:52.359Z (almost 2 years ago)
- Language: Shell
- Size: 6.84 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# edx_pygration
Test in problem python code for [edX] courses
## Features
- Users can:
- Get all problem based python code out of the course automatically
- Get python_lib.zip python code out of the course automatically
- Test environment based functionality for all pulled python code.
## Requires
A UNIX based OS (tested on Ubuntu 20.04 Focal Fassa)
## Use
### Clone the Repo to your local machine
```
git clone https://github.com/connor-makowski/edx_pygration.git
```
### Chmod the Repo
```
sudo chmod -R 777 ./edx_pygration/
```
### Export Course Data
In edx Studio:
- Navigate to Tools > Export
- Export the course content
- Download the exported course content
On your local machine
- Place the exported `tar.gz` file in `edx_pygration/course_dumps`
### Extract all courses in course_dumps and preprocess all python data
```
./extract.sh
./preprocess.sh
```
Note: All python code should now cleanly be located in each item in `edx_pygration/extracted_courses/{course_name}/python`
Note: You should check this to make sure that your code does not have caveats that prevent the preprocess step from working properly.
### Set up a test virtualenv
```
virtualenv -p python36 venv
source venv/bin/activate
pip install -r requirements.txt
```
Note: You can use any python environment you want to test with.
### Using extra python imports
You can install extra python packages into your local `venv` for testing purposes.
If you use extra requirements or imports in your python scripts in edx, you can adjust `edx_pygration/preprocess.sh` to meet your needs by adding the following line:
```
echo "import mypackage" >> "./$folder/python/$(basename $xmlfile .xml).py"
```
This line should go between the following two lines:
```
echo "import math, random, scipy, numpy" > "./$folder/python/$(basename $xmlfile .xml).py"
sed -n '/^.*.*$/p' $xmlfile | sed '1d;$d' >> "./$folder/python/$(basename $xmlfile .xml).py"
```
- Note: Make sure to adjust `mypackage` to any package you want to import.
- Note: Feel free to add multiple lines here.
### Test all python files in all courses for errors
```
./test.sh
```
Note: Only files that throw flags or return content to the console are logged when running `./test.sh`. This means that no results are good results.
[//]: # (These are reference links used in the body of this note and get stripped out when the markdown processor does its job.)
[edX]: