Skip to content

Latest commit

 

History

History
117 lines (97 loc) · 3.8 KB

README.md

File metadata and controls

117 lines (97 loc) · 3.8 KB
Raw

This repository contains the Django database and web API code. For information about contributing to Autograder.io, see our contributing guide.

Server Dev Setup

This tutorial will walk you through setting up your local machine for modifying and testing the server code.

System Requirements

Supported Operating Systems:

  • Ubuntu 16.04

It may be possible to run the server tests on OSX. If you decide to try this, you're on your own. Newer versions of Ubuntu are probably ok, but may require extra effort to install Postgres 9.5 or change the configuration to use a newer version (the latter applies to full stack development and deployment).

Clone and Checkout

git clone [email protected]:eecs-autograder/autograder-server.git
cd autograder-server
git checkout develop

Install Docker Community Edition

Ubuntu: https://docs.docker.com/install/linux/docker-ce/ubuntu/#install-docker-ce-1

Install Postgres

sudo apt-get install postgresql-9.5 postgresql-client-9.5 postgresql-contrib-9.5 postgresql-server-dev-9.5

Set a password for the 'postgres' user.

sudo -u postgres psql -c "alter user postgres with password 'postgres'"

If you choose a different password, you'll need to set the AG_DB_PASSWORD environment variable with your chosen password:

export AG_DB_PASSWORD=<password>

Install Redis Server

sudo apt-get install redis-server

Install Python 3.8

sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt-get update
sudo apt-get install python3.8 python3.8-venv python3.8-dev
curl https://bootstrap.pypa.io/get-pip.py | sudo python3.8

python3.8 -m venv venv
source venv/bin/activate
pip install --upgrade pip
pip install wheel
pip install -r requirements.txt
pip install -r requirements-dev.txt

Generate Secrets

Run the following command to generate the file autograder/settings/secrets.json:

python3.8 manage.py generate_secrets

Running the Unit Tests

To run the tests (takes about 15 minutes on my machine):

python3.8 manage.py -v 2 test

Updating schema.yml and Rendering the Schema

This project uses DRF's schema generation as a starting point for discovering API operations and their URL params. We extend this functionality in autograder/rest_api/schema.py to add Model Schema generation and to fill in endpoint details.

To update schema.yml, run:

./manage.py generateschema --generator_class autograder.rest_api.schema.AGSchemaGenerator > schema/schema.yml

If you are running the full development stack, you may skip the next step.

To render and serve the API using Swagger UI, run (requires Docker):

# Run from the project root directory, i.e. "autograder-server"
docker run -d --name ag_schema -p 8080:8080 --env-file schema/env -v $(pwd)/schema:/root swaggerapi/swagger-ui

Then navigate to localhost:8080 in your browser. To change the port, change 8080:8080 to <your port>:8080, e.g. 9001:8080.

Coding Standards

In addition to the items listed here, all source code must follow our Python coding standards.

This project uses pycodestyle, pydocstyle, and mypy as linters. They can be run using the following commands:

pycodestyle autograder
pydocstyle autograder
sh run_mypy.sh

Use these import aliases for commonly-used modules: - import autograder.core.models as ag_models - NOTE: Do NOT import autograder.core.models from modules inside that package. - import autograder.core.fields as ag_fields - import autograder.rest_api.permissions as ag_permissions - import autograder.rest_api.serializers as ag_serializers - import autograder.core.utils as core_ut - import autograder.handgrading.models as hg_models