An example of setting up a RESTful Pyramid Web Server that communicates with a MySQL database

Usage Instructions

Native Usage

---

1. Create database credentials (and of course complete the user and password):

   echo "MYSQL_HOST=localhost" > credentials.env
   echo "MYSQL_DATABASE=ece140" >> credentials.env
   echo "MYSQL_USER=" >> credentials.env
   echo "MYSQL_PASSWORD=" >> credentials.env

2. Install MySQL Server on your computer

3. Run init-db.sql to create the database (in the database folder)

   mysql -u root -p
   source init-db.sql
   exit

4. Install the Python dependencies from requirements.txt

   pip3 install -r requirements.txt

5. Source the environment variables into your path

   source credentials.env

   NOTE: Windows users, I'm sorry your life is always harder. Please follow this guide to read environment variables into your path: https://bennett4.medium.com/windows-alternative-to-source-env-for-setting-environment-variables-606be2a6d3e1

6. Run the server

   python3 server.py

7. Point your browser to the webserver routes (might be http://localhost on some machines):

   • GET / Route: http://0.0.0.0
   • GET /actors Route: http://0.0.0.0/actors
   • GET /actor/[actor-id] Route: http://0.0.0.0/actor/[actor-id]

Docker-based Usage

---

1. Create database credentials (and of course complete the user and password):

   echo "MYSQL_HOST=mysql-server" > credentials.env
   echo "MYSQL_DATABASE=ece140" >> credentials.env
   echo "MYSQL_USER=" >> credentials.env
   echo "MYSQL_PASSWORD=" >> credentials.env

2. Run the following command to build the containers and start up both web server and database containers:

   docker compose up --build

3. In a new terminal window, open an interactive shell into the web server container and start the web server:

   docker exec -it 140-web-server bash
   python server.py

4. Point your browser to the webserver routes (might be http://localhost on some machines):

   • GET / Route: http://0.0.0.0
   • GET /actors Route: http://0.0.0.0/actors
   • GET /actor/[actor-id] Route: http://0.0.0.0/actor/[actor-id]