How tinocoalexander/surveyanalytics works
Project type and purpose
• This is a monolithic, full-stack Django web application named SurveyAnalytics.
• Purpose: allow authenticated users to upload survey response files (CSV/XLS/XLSX), process them with Pandas, generate charts via Matplotlib, display insights in HTML, and produce downloadable PDF reports via WeasyPrint.
File structure
• Top level:
• manage.py and survey_analytics/ (Django project settings, ASGI/WSGI, global URLs)
• apps: analysis/, users/, errors/
• static/ (CSS, JS, images)
• media/ (uploaded survey files)
• Each app follows Django’s MVC: models.py, views.py, urls.py, templates/, migrations/.
• Configuration: settings.py uses python-decouple for env vars; static and media roots defined; error app for custom HTTP error pages.
README insights
• Tech stack: Django 5.1.5, Python 3.12, Pandas, Matplotlib, WeasyPrint, python-decouple, django-widget-tweaks.
• Workflow: User → login/register → upload survey → Pandas analysis + Matplotlib charts → render in HTML + PDF via WeasyPrint → CRUD (list/delete) surveys.
• Deployment: production uses Gunicorn/uWSGI + Nginx, environment variables, ALLOWED_HOSTS, static/media handling.
Main components and interactions
a. Components
1. Client (Browser)
2. Static Asset Server (via Django or Nginx/CDN)
3. Django Web Server (Gunicorn/uWSGI)
• URL Router
• Users App (authentication, email via SMTP)
• Analysis App (file upload, data pipeline, chart generation, PDF generation)
• Errors App (custom 400/401/404 pages)
4. Database (e.g., PostgreSQL or SQLite)
5. File Storage (media/ directory for uploaded surveys)
6. External Services
• SMTP Email Server (activate accounts, password reset)
• WeasyPrint (renders HTML → PDF)
• Matplotlib (generates .png images of charts)
7. Environment Variables Provider (python-decouple/.env)
b. Relationships & data flows
• Browser → HTTP(S) → Django Web Server
• Django → ORM → Database
• File upload: Browser → Django → save file → media storage
• Analysis pipeline: Django reads file from media → Pandas processes → Matplotlib outputs chart images → templates embed charts + insights
• PDF report: HTML template → WeasyPrint → PDF delivered to Browser
• SMTP: Django Users App → SMTP credentials → send activation/reset emails
• Static files: Browser fetches CSS/JS/images from static server
c. Architectural patterns & principles
• Monolithic MVC: separation of concerns between models, views, templates
• Three Django apps = modular structure (authentication, business logic, error handling)
• Single codebase deploys to one web server process; static assets can be offloaded to CDN
• Data pipeline stage: file ingestion → processing → visualization → reporting
d. Key technologies
• Django (request routing, ORM, templating)
• Pandas (data manipulation)
• Matplotlib (chart rendering)
• WeasyPrint (HTML-to-PDF)
• python-decouple (config management)
• django-widget-tweaks (form rendering)