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
TODO(salikh): Publish prog_edu_assistant_tools
package to PyPI.
pip install dist/prog_edu_assistant_tools-0.2-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.2-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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b551c62dc12a521b19fdd442dc84eb42b76df743d59e246114c5d036dde75021 |
|
MD5 | d1b7f7db2c5ca8948197595770ac0813 |
|
BLAKE2b-256 | b7fb8e0b901edfa230641907c2ada703bbbadc2b42f3f94ef59b7c1bc610bbfc |
Hashes for prog_edu_assistant_tools-0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a257de9db0ffac90f7463201f52e72881e3bfcc216dd6a0e74f6541509a40cea |
|
MD5 | f107056c2b4e2c6850e4804cf7899f92 |
|
BLAKE2b-256 | 721e7d266e384196b2eda0a8784899c6491bd60155de3e03e2a3028c03e3df89 |