Project refactor

.env

@@ -0,0 +1,2 @@
+PORT=8000
+HOST=127.0.0.1

.gitignore

@@ -0,0 +1,2 @@
+**/__pycache__
+/logs/*.log

.vscode/launch.json

@@ -0,0 +1,15 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python: Module",
+            "type": "python",
+            "request": "launch",
+            "module": "server_stats",
+            "justMyCode": true
+        }
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,18 @@
+{
+    "python.formatting.provider": "black",
+    "terminal.integrated.env.linux": {
+        "PYTHONPATH": "${workspaceRoot}/src"
+    },
+    "terminal.integrated.env.windows": {
+        "PYTHONPATH": "${workspaceRoot}/src"
+    },
+    "files.exclude": {
+        "**/__pycache__": true,
+        "**/.pytest_cache": true
+    },
+    "python.testing.pytestArgs": [
+        "src"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true
+}

README.md

@@ -18,40 +18,42 @@ Three smaller, more detailed sections to view more in depth statistics on hardwa
 
 ## Tech
 
-
-
 - [FastAPI](https://fastapi.tiangolo.com/) -
 - HTML/CSS/JS
 - [ChartJS](https://www.chartjs.org/)
 - [Poetry](https://python-poetry.org/docs/basic-usage/)
 - [Pytest](https://docs.pytest.org/en/7.1.x/)
 
-## Usage
-- Run main.py on the computer you wish to monitor, then connect to it via LAN (http://LANIP:8080/stats)
-
-
-
 ## Installation
 
 [Python 3.7+](https://www.python.org/)
 
 To run:
 ```
 poetry install
-poetry run python main.py
+poetry run python -m server_stats
 ```
-Connect to your ip, at the endpoint '/stats' on port 8080
+Connect to your ip, at the main endpoint on port 8000 (by default)
 ```
-http://YOUR_IP:8080/stats (if accessing from a different client machine than the host)
-http://localhost:8080/stats (if youre accessing from the host machine)
+http://YOUR_IP:8000/(if accessing from a different client machine than the host)
+http://localhost:8080/ (if youre accessing from the host machine)
 ```
 To run tests (development only):
 ```
 poetry run pytest
 ```
 ## Development
 
-Want to contribute? Great!
+### Contributors
+
+...
+
+### TODO
+
+- [ ] Temperature monitoring for Windows
+- [ ] Visual display of temperature
+- [ ] Js module for charts
+- [ ] App integration tests strategy
 
 
 ## License

pyproject.toml

@@ -1,25 +1,26 @@
 [tool.poetry]
-name = "pythonproject"
+name = "server-stats"
 version = "0.1.0"
 description = ""
 authors = []
 
 [tool.poetry.dependencies]
-python = "^3.10"
+python = ">=3.8.10,<=3.10"
 fastapi = "^0.79.0"
 psutil = "^5.9.1"
 uvicorn = {extras = ["standard"], version = "^0.18.2"}
 Jinja2 = "^3.1.2"
 websockets = "^10.3"
+python-dotenv = "^0.20.0"
 
 [tool.poetry.dev-dependencies]
 black = "^22.6.0"
 pytest = "^7.1.2"
+pytest-asyncio = "^0.19.0"
 httpx = "^0.23.0"
 requests = "^2.28.1"
 trio = "^0.21.0"
 asyncio = "^3.4.3"
-pytest-asyncio = "^0.19.0"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

src/server_stats/__init__.py

@@ -0,0 +1,8 @@
+# REVIEW: in order to be recognized as a module must have a __init__.py file
+# https://docs.python.org/3.8/library/__main__.html. Module can now be run with python -m "module name"
+
+import logging
+
+from .constants import LOGGING_DIR
+
+logging.basicConfig(filename=LOGGING_DIR, filemode="w", level=logging.DEBUG)

src/server_stats/__main__.py

@@ -0,0 +1,95 @@
+# REVIEW: imports should be sorted in groups: top is python standard library, middle is third party, bottom is local
+import logging
+
+import uvicorn
+from fastapi import FastAPI, HTTPException, Request, WebSocket
+from fastapi.responses import HTMLResponse
+from fastapi.staticfiles import StaticFiles
+from fastapi.templating import Jinja2Templates
+
+# REVIEW: all internal imports should be relative
+from .connection_manager import ConnectionManager
+from .constants import (
+    HOST,
+    PORT,
+    ROOT,
+    STATIC_DIR,
+    STATIC_ROUTE,
+    TEMPLATES_DIR,
+    WEBSOCKET_ROUTE,
+)
+from .computer import Computer
+from .helpers import generate_id
+
+# REVIEW: best practice for logger is to initialize logger settings in __ini__.py
+# then get the logger when being used in a script. __name__ is going to return main which was
+# the name of the logger
+logger = logging.getLogger(__name__)
+
+# REVIEW: the __main__.py (called a dunder main) is the top-level script that is executed when the program is run
+# https://docs.python.org/3.8/library/__main__.html
+
+# REVIEW: good to have a separate function for main and
+# call it in the if statement below
+app = FastAPI()
+connection_manager = ConnectionManager()
+templates = Jinja2Templates(directory=TEMPLATES_DIR)
+
+# REVIEW: Didn't do a ton of research on this but this may not be the recommended mounting pattern for static files
+# https://fastapi.tiangolo.com/tutorial/static-files/
+app.mount(
+    STATIC_ROUTE,
+    # REVIEW: file paths should be constants in most cases
+    StaticFiles(directory=STATIC_DIR),
+    name="static",
+)
+
+
+# REVIEW: not really needed to type NoReturn, can just have no type hint
+# or type hint None if you really feel like it
+@app.get("/favicon.ico")
+async def favicon() -> None:
+    # No current FavIcon - fix later
+    raise HTTPException(status_code=403, detail="No favicon")
+
+
+# REVIEW: Since there is only a single endpoint it should be kept as root
+@app.get(ROOT, response_class=HTMLResponse)
+def root(request: Request):
+    """
+    HTTP endpoint to serve the Server Statistics Dashboard
+    :param request: HTTP Request from Client
+    :return: Returns the associated HTML files to the requesting client
+    """
+    client_id = generate_id()
+    return templates.TemplateResponse(
+        "index.html", {"request": request, "id": client_id}
+    )
+
+
+# REVIEW: Since there is only a single websocket it should be kept as root. As you add
+# more websockets you can change this if necessary
+@app.websocket(WEBSOCKET_ROUTE)
+async def root_websocket(client_websocket: WebSocket):
+    """
+    Web Socket endpoint for communicating the "Server Statistics" in JSON to the client. Communication with the
+    data visualization client is done here.
+    :param client_websocket: Incoming Web Socket request.
+    :return: No explicit return, just continuous requests for information from client
+    """
+    # REVIEW: don't need to resend the connection since the .connect method already does this
+    await connection_manager.connect(client_websocket)
+    # Initial connection
+    while True:
+        # Client sending data....
+        data = await client_websocket.receive_json()
+
+        # DATAREQUEST is the asking protocol from the client requesting for the Hardware stats
+        if data["event"] == "DATAREQUEST":
+            await client_websocket.send_json(
+                {"event": "DATAREQUEST", "stats": Computer().get_stats_dict()}
+            )
+
+
+if __name__ == "__main__":
+    uvicorn.run(app, port=PORT, host=HOST)