Tools for authoring programming assignments in Jupyter notebooks
Project description
prog_edu_assistant_tools
Tools to create autogradeable assignments in Jupyter notebooks. See the documentation in https://github.com/google/prog-edu-assistant to get started with the autograder.
This package contains a few functions that makes authoring programming assignments in Jupyter more convenient, including the following:
- A summarizing test runner to run unit tests
- A function that can run a unit test directly in the Jupyter notebook
The intention of this package is to hide all the smarts of having a complete master notebook capable of complete auto-testing behind nice and readable names that can be imported rather than reimplemented in every master notebook.
How to build this package
source ../../../venv/bin/activate
python setup.py bdist_wheel sdist
How to push this package to PyPI
pip install --upgrade twine
python setup.py bdist_wheel sdist
python3 -m twine upload --repository-url https://upload.pypi.org/legacy/ dist/*
How to install this package locally
pip install dist/prog_edu_assistant_tools-0.3.1-py3-none-any.whl
If you are a developer and want to reinstall the package, use the following:
pip install --ignore-installed dist/prog_edu_assistant_tools-0.3.1-py3-none-any.whl
How to use this package in master notebooks.
Here are some useful snippets for your master assignment notebooks:
from prog_edu_assistant_tools.summary_test_result import SummaryTestResult
from prog_edu_assistant_tools.magics import autotest, report
# Loads %%solution, %%submission, %%template
%load_ext prog_edu_assistant_tools.magics
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for prog_edu_assistant_tools-0.3.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bc12842df86dd40ec6f029d79ae6d1caa52ff2531537a2775484e3f12e771ac4 |
|
MD5 | 4c5068c6fd87fe186a335b225baf69fa |
|
BLAKE2b-256 | 06059892494a9d5c9b858fbac3a87fcc41b3638ef71c523d0c808d350aaf1843 |
Hashes for prog_edu_assistant_tools-0.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 567783d8f1bc3684c4a3e0bc91e92269eeddc59cbf0fa14407a2f6087c41beda |
|
MD5 | 3f421ed5383bb1e70392a2d6270e02d1 |
|
BLAKE2b-256 | 71a89d154535605c8e060e751b51e1b13dbadfcbc4e4a54aba740137d867c6cd |