Weirui-Leo commited on
Commit
6a8626d
·
1 Parent(s): 6c881e5

fix: add module docstring and resolve Pylint warnings (i hope)

Browse files
app/app.py CHANGED
@@ -4,7 +4,7 @@ import logging
4
  from flask import Flask
5
  from flask_apscheduler import APScheduler
6
  from asgiref.wsgi import WsgiToAsgi
7
- from controllers.category import category_bp
8
 
9
  # from routes.summary import summary_bp
10
 
@@ -36,7 +36,7 @@ def create_app():
36
  flask_app = Flask(__name__)
37
  # flask_app.config.from_object(Config())
38
  # flask_app.register_blueprint(summary_bp, url_prefix='/summary')
39
- flask_app.register_blueprint(category_bp, url_prefix='/summary')
40
 
41
  logging.basicConfig(
42
  format='%(asctime)s - %(levelname)s - %(funcName)s - %(message)s')
 
4
  from flask import Flask
5
  from flask_apscheduler import APScheduler
6
  from asgiref.wsgi import WsgiToAsgi
7
+ from routes.category_router import category_bp
8
 
9
  # from routes.summary import summary_bp
10
 
 
36
  flask_app = Flask(__name__)
37
  # flask_app.config.from_object(Config())
38
  # flask_app.register_blueprint(summary_bp, url_prefix='/summary')
39
+ flask_app.register_blueprint(category_bp, url_prefix='/summary')
40
 
41
  logging.basicConfig(
42
  format='%(asctime)s - %(levelname)s - %(funcName)s - %(message)s')
app/controllers/category.py CHANGED
@@ -1,3 +1,9 @@
 
 
 
 
 
 
1
  from database.mongodb import category_collection
2
  def get_categories():
3
 
 
1
+ """
2
+ Category Controller - Business logic for handling category data.
3
+
4
+ This module contains functions that interact with the database
5
+ to fetch and process data sorted by category
6
+ """
7
  from database.mongodb import category_collection
8
  def get_categories():
9
 
app/routes/category_router.py CHANGED
@@ -1,3 +1,12 @@
 
 
 
 
 
 
 
 
 
1
  from controllers.category import get_categories
2
  from flask import jsonify
3
  from . import category_bp
@@ -10,9 +19,6 @@ def fetch_categories():
10
  Returns:
11
  list[dict]: JSON response containing categories and their associated sites.
12
 
13
- Raises:
14
- tbd
15
-
16
  Endpoint:
17
  GET /api/category
18
 
 
1
+ """
2
+ Defines Flask routes for handling call by category
3
+
4
+ This module contains API endpoints for managing and retrieving categories
5
+ from the MongoDB database.
6
+
7
+ Routes:
8
+ - GET /api/category: Fetch all categories.
9
+ """
10
  from controllers.category import get_categories
11
  from flask import jsonify
12
  from . import category_bp
 
19
  Returns:
20
  list[dict]: JSON response containing categories and their associated sites.
21
 
 
 
 
22
  Endpoint:
23
  GET /api/category
24