Metadata-Version: 2.1
Name: prog-edu-assistant-tools
Version: 0.3.1
Summary: Tools for authoring programming assignments in Jupyter notebooks
Home-page: https://github.com/google/prog-edu-assistant/tree/master/python/prog_edu_assistant_tools
Author: Salikh Zakirov
Author-email: salikh@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: Jinja2
Requires-Dist: IPython

# 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



