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-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-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.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 284c350e10fed904a6b97441ce16e68e8312cb79312c1642276146a2188bc2d1 |
|
MD5 | 8cd5463f568eddeb5fb61eeff9e2a029 |
|
BLAKE2b-256 | 71fc2fe107e322dfdff35b501ebe18dfb1ac9a705a39d9e66b0efec71e4c052e |
Hashes for prog_edu_assistant_tools-0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 695865e7d749dc48abad34abc7f7ca49aef34d9f74d4cd24ab6ce6b123f81902 |
|
MD5 | 7fd10038779e140ad7cda73ecad3b8f6 |
|
BLAKE2b-256 | 250dfe5222dee46140912985d64f249bb3d4191c7354fe4cca982fc9a601a8e5 |