This document provides an overview and documentation of a Python script that creates a Flask web application connected to a MongoDB database. The application offers various API routes for managing student and student task data. Below is a detailed breakdown of the code, including explanations for each route.
\nmongodb://localhost:27017 with a database named school.from flask import Flask, jsonify, request\nfrom flask_pymongo import PyMongo\nfrom datetime import datetime\n\nThe script imports necessary libraries for creating a Flask application, interacting with a MongoDB database, and managing date values for the database.
\napp = Flask(__name__)\napp.config['MONGO_URI'] = 'mongodb://localhost:27017/school'\nmongo = PyMongo(app)\n\nHere, a Flask app is created, and it is configured to use the specified MongoDB URI. A connection to the MongoDB database is established using Flask-PyMongo.
\nadd_student Route - [ POST ]@app.route('/add_student', methods=['POST'])\ndef add_student():\n # Extract data from the request\n # ...\n # Insert student data into the database\n # ...\n # Return a success response\n # ...\n\nThis route allows the addition of a single student to the database. It extracts data from the JSON request and inserts it into the MongoDB students collection. The route returns a success response upon completion.
add_students Route - [ POST ]@app.route('/add_students', methods=['POST'])\ndef add_students():\n # Extract data from the request\n # ...\n # Insert multiple students into the database\n # ...\n # Return a success response\n # ...\n\nThis route is used for adding multiple students to the database in a single request. It expects a list of student objects in the request's JSON body and inserts them into the students collection.
get_single_student Route - [ GET ]@app.route('/get_student/<student_id>', methods=['GET'])\ndef get_single_student(student_id):\n # Find a single student by student_id\n # ...\n # Return the student as JSON\n # ...\n\nThis route retrieves a single student's data by their student_id and returns it as a JSON response.
get_all_students Route - [ GET ]@app.route('/get_students', methods=['GET'])\ndef get_all_students():\n # Find all students in the database\n # ...\n # Return a list of students as JSON\n # ...\n\nThis route retrieves all student data from the database and returns it as a list of JSON objects.
\nupdate_student Route - [ PUT ]@app.route('/update_student/<student_id>', methods=['PUT'])\ndef update_student(student_id):\n # Extract data from the request\n # ...\n # Update the student's data in the database\n # ...\n # Return a success response\n # ...\n\nThis route allows the update of a student's data by their student_id. It extracts the updated data from the request and updates the corresponding record in the database.
soft_delete_student Route -[ DELETE ]@app.route('/soft_delete_student/<student_id>', methods=['DELETE'])\ndef soft_delete_student(student_id):\n # Soft delete a student by setting 'is_deleted' to True\n # ...\n # Return a success response\n # ...\n\nThis route soft deletes a student by setting their is_deleted field to True, indicating that they are marked for deletion.
hard_delete_student Route - DELETE@app.route('/hard_delete_student/<student_id>', methods=['DELETE'])\ndef hard_delete_student(student_id):\n # Hard delete a student by removing the record from the database\n # ...\n # Return a success response\n # ...\n\nThis route hard deletes a student by completely removing their record from the database.
\nThe script also includes a set of API routes for managing student tasks. These routes have a similar structure to the student-related routes but are focused on tasks associated with students. They allow the addition, retrieval, update, and soft and hard deletion of student tasks.
\n@app.errorhandler(404)\ndef not_found(error=None):\n # Handle 404 errors by returning a custom JSON response\n # ...\n\nThe script defines an error handler for 404 errors, returning a custom JSON response indicating that the requested resource was not found.
\nif __name__ == '__main__':\n app.run(debug=True)\n\nThis section starts the Flask application with debugging enabled if the script is executed directly.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"30488427","collectionId":"bfa50d53-27c9-4be9-8009-121d6ce8e398","publishedId":"2s9YR9YsmV","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-10-19T04:57:45.000Z"},"item":[{"name":"MongoDB Database","item":[],"id":"a693942e-9dd1-4217-b6a5-032efa8e935f","description":"This document provides instructions for initializing a MongoDB database named \"school\" with two collections: \"students\" and \"student_tasks.\" It includes details about the format of each collection and provides sample documents for each.
\nTo initialize the \"school\" database, you can use the MongoDB command-line client or a MongoDB GUI tool like MongoDB Compass. Connect to your MongoDB server and execute the following commands:
\nuse school\n\nThis command switches to the \"school\" database. If the database doesn't exist, it will be created.
\nThe \"students\" collection stores information about students. It has the following fields:
\nstudent_id: String (unique identifier for each student)first_name: String (first name of the student)last_name: String (last name of the student)age: Integer (age of the student)gender: String (gender of the student)image: String (URL to the student's image)active: Boolean (whether the student is active)is_deleted: Boolean (whether the student is deleted)created: Timestamp (date and time of creation)created_by: String (creator's name)last_updated: Timestamp (date and time of the last update)last_updated_by: String (name of the user who last updated)Here are three example documents to initialize the \"students\" collection:
\n{\n \"student_id\": \"1\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"age\": 20,\n \"gender\": \"Male\",\n \"image\": \"https://example.com/johndoe.jpg\",\n \"active\": true,\n \"is_deleted\": false,\n \"created\": new Date(\"2020-05-01\"),\n \"created_by\": \"Admin\",\n \"last_updated\": new Date(),\n \"last_updated_by\": \"Admin\"\n}\n\n{\n \"student_id\": \"2\",\n \"first_name\": \"Alice\",\n \"last_name\": \"Smith\",\n \"age\": 22,\n \"gender\": \"Female\",\n \"image\": \"https://example.com/alicesmith.jpg\",\n \"active\": true,\n \"is_deleted\": false,\n \"created\": new Date(\"2020-05-02\"),\n \"created_by\": \"Admin\",\n \"last_updated\": new Date(),\n \"last_updated_by\": \"Admin\"\n}\n\n{\n \"student_id\": \"3\",\n \"first_name\": \"Bob\",\n \"last_name\": \"Johnson\",\n \"age\": 19,\n \"gender\": \"Male\",\n \"image\": \"https://example.com/bobjohnson.jpg\",\n \"active\": true,\n \"is_deleted\": false,\n \"created\": new Date(\"2020-05-03\"),\n \"created_by\": \"Admin\",\n \"last_updated\": new Date(),\n \"last_updated_by\": \"Admin\"\n}\n\nThe \"student_tasks\" collection stores information about student tasks. It has the following fields:
\ntask_id: String (unique identifier for each task)student_id: String (identifier of the student who submitted the task)score: Float (the score received for the task)is_deleted: Boolean (whether the task is deleted)created: Timestamp (date and time of creation)created_by: String (creator's name)last_updated: Timestamp (date and time of the last update)last_updated_by: String (name of the user who last updated)Here are three example documents to initialize the \"student_tasks\" collection:
\n{\n \"task_id\": \"task1\",\n \"student_id\": \"1\",\n \"score\": 95.5,\n \"is_deleted\": false,\n \"created\": new Date(\"2020-05-10\"),\n \"created_by\": \"Admin\",\n \"last_updated\": new Date(\"202-05-30\"),\n \"last_updated_by\": \"Admin\"\n}\n\n{\n \"task_id\": \"task2\",\n \"student_id\": \"1\",\n \"score\": 88.0,\n \"is_deleted\": false,\n \"created\": new Date(\"2020-05-30\"),\n \"created_by\": \"Admin\",\n \"last_updated\": new Date(\"2020-06-10\"),\n \"last_updated_by\": \"Admin\"\n}\n\n{\n \"task_id\": \"task3\",\n \"student_id\": \"2\",\n \"score\": 92.5,\n \"is_deleted\": false,\n \"created\": new Date(\"2020-06-25\"),\n \"created_by\": \"Admin\",\n \"last_updated\": new Date(\"2020-08-20\"),\n \"last_updated_by\": \"Admin\"\n}\n\nYou can use these example documents as a starting point for your \"students\" and \"student_tasks\" collections in the \"school\" database. Customize and insert more data as needed for your application.
\nafter typing use school you should have the following display
Adding the data into the collections will follow the following format db..insertOne() to insert a single student record.
For the \"students\" collection we can insert the first sample record as follows:
\nFor the \"student_tasks\" collection we can insert the first sample record as follows:
\nThis is a POST method with a route to add a single student to the \"students\" collection in the school database
This is a POST method with a route to add multiple students to the \"students\" collection in the school database
This is a GET method with a route to get a single student from the \"students\" collection 'based on their unique student_id
This is a GET method with a route to get all the available student records from the \"students\" collection
This is a PUT method with a route to update a single student record from the \"students\" collection
This is a DELETE method with a route to soft delete a single student record by setting the is_delted property to true
This is a DELETE method with a route to hard delete a single student record by removing the entire record using the student_id
The following requests are done on the students collection inside the school database
\n","_postman_id":"ff0b45a2-d354-4126-8bef-5afe131cb2be"},{"name":"student_tasks collection","item":[{"name":"getting a single student task","id":"335b65a9-8242-4217-ade1-4ba8fe5ca906","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://127.0.0.1:5000/get_student_task/task1","description":"This is a GET method with a route to retrieve a single student task from the \"student_tasks\" collection
This is a GET method with a route to retrieve all tasks for a single student
This is a POST method with a route to add a single student task to the \"student_tasks\" collection in the school database
\n","urlObject":{"protocol":"http","port":"5000","path":["add_student_task"],"host":["127","0","0","1"],"query":[],"variable":[]}},"response":[],"_postman_id":"7467786e-be7e-4a05-9086-5ccb059e65fa"},{"name":"Updating a single task","id":"20bba47b-6764-4edc-b9e2-259794ce69e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"task_id\": \"task2.1\",\r\n \"student_id\": \"2\",\r\n \"score\": 95.32,\r\n \"is_deleted\": false,\r\n \"created\": \"2020-10-18\",\r\n \"created_by\": \"Admin\",\r\n \"last_updated\": \"2020-11-30\",\r\n \"last_updated_by\": \"Admin\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://127.0.0.1:5000/update_student_task/task2","description":"This is a PUT method with a route to update a single student task based on the task_id
\n","urlObject":{"protocol":"http","port":"5000","path":["update_student_task","task2"],"host":["127","0","0","1"],"query":[],"variable":[]}},"response":[],"_postman_id":"20bba47b-6764-4edc-b9e2-259794ce69e2"},{"name":"Soft delete a single task","id":"bdb3c4a4-efed-41e6-a26b-41b7d5b68569","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"http://127.0.0.1:5000/soft_delete_student_task/task2.1","description":"This is a DELETE method with a route to soft delte a single student task from the \"student_tasks\" collection in the school database using the task_id
\n","urlObject":{"protocol":"http","port":"5000","path":["soft_delete_student_task","task2.1"],"host":["127","0","0","1"],"query":[],"variable":[]}},"response":[],"_postman_id":"bdb3c4a4-efed-41e6-a26b-41b7d5b68569"},{"name":"Hard delete a single task","id":"31a5e523-5c1b-4830-aebb-82363c6bd05c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"http://127.0.0.1:5000/hard_delete_student_task/task2.1","description":"This is a DELETE method with a route to hard delete a single student task from the \"student_tasks\" collection in the school database using the task_id
\n","urlObject":{"protocol":"http","port":"5000","path":["hard_delete_student_task","task2.1"],"host":["127","0","0","1"],"query":[],"variable":[]}},"response":[],"_postman_id":"31a5e523-5c1b-4830-aebb-82363c6bd05c"}],"id":"2df76a69-cca9-437e-a885-8865c168371f","description":"The following requests are done on the student_tasks collection inside the students database
\n","_postman_id":"2df76a69-cca9-437e-a885-8865c168371f"}],"id":"ec7ddaee-70c1-470b-83f8-076849787ea8","description":"Before we can test our requests we need to ensure that the Flask application is currently running on port http://127.0.0.1:5000
go to the directory that you have saved your app.py script file in and type python app.py to run the script
> The terminal should be open throught the testing of requests
\n","_postman_id":"ec7ddaee-70c1-470b-83f8-076849787ea8"}]}