DEVELOP.md

Development Notes

This project adopts the new configuration file pyproject.toml per PEP 518 and uses Poetry as build dependency. Although Poetry is not required to use this project just for notebook grading, we recommend installing it for project development.

Project Structure

• src/aibuilders_exam Python source code to grading scripts
• exam.ipynb Jupyter notebook containing exam questions
• grade.py Grading script for exam.ipynb

Development Setup

1. Install the following tools to local development machine:
   • Python ≥ 3.7.1, < 3.8.0 (pro tip: use pyenv)
   • Poetry 1.2.0a2
   • Just
   • Pre-commit
2. Install dependencies with Poetry

   $ poetry install

   and run post installation script (will install pre-commit hooks)

   $ just post-install

Package Dependency Management

All Python package dependencies are configured in pyproject.toml. The pre-commit script will ensure that frozen dependencies are automatically generated and saved into poetry.lock and requirements.txt.