Runestone BookServer
latest
  • New FastAPI-based Book Server for Runestone
  • Developer documentation
    • BookServer web application
      • Design
      • Development guidelines
      • main.py - Define the BookServer
      • models.py - definition of database models
      • schemas.py – Define validation for endpoint query parameters
      • db.py - Database configuration
      • session.py - Session Management
      • applogger.py - Configure logging for the BookServer
      • crud.py - reusable functions for our data model
      • Routers
      • Internals – TODO a good description here
        • utils.py - Utility functions
        • feedback.py - Provide feedback for student answers
        • scheduled_builder.py - Provide feedback for student answers
        • common_builder.py - Routines shared between the server and WAF build
        • __init__.py - Declare this directory a package
      • login.html - template for the login page
      • config.py - Configuring Runestone BookServer
      • __main__.py - Provide a simple method to run the server
    • Database migration using Alembic
    • Testing for the BookServer
    • pre_commit_check.py - Formatting, Lint, and Unittests
    • pyproject.toml - Poetry configuration
    • .gitignore - Ignores for Git
    • .flake8 - Flake8 configuration
    • mypy.ini - mypy configuration
    • tox.ini
    • .coveragerc - Configure code coverage
    • conf.py - Configuration file for BookServer documentation
    • codechat_config.yaml - Configuration for a CodeChat project
    • .readthedocs.yml - Read the Docs configuration file
  • The MIT License (MIT)
Runestone BookServer
  • »
  • Developer documentation »
  • BookServer web application »
  • Internals – TODO a good description here
  • Edit on GitHub

Internals – TODO a good description here

  • utils.py - Utility functions
  • feedback.py - Provide feedback for student answers
  • scheduled_builder.py - Provide feedback for student answers
  • common_builder.py - Routines shared between the server and WAF build
  • __init__.py - Declare this directory a package
Previous Next

© Copyright 2020, 2021, Runestone Interactive LLC. Revision 5fa7289c. Last updated on Jun, 30, 2022.

Built with Sphinx using a theme provided by Read the Docs.