student-feedback-system 1.0.0__tar.gz

student_feedback_system-1.0.0/MANIFEST.in

@@ -0,0 +1,4 @@
+recursive-include feedback_system/templates *.html
+recursive-include feedback_system/static *.css *.js *.png *.ico
+include README.md
+include LICENSE

student_feedback_system-1.0.0/PKG-INFO

@@ -0,0 +1,140 @@
+Metadata-Version: 2.4
+Name: student-feedback-system
+Version: 1.0.0
+Summary: A plug-and-play student feedback web application built with Flask
+Author: Student DevOps Lab
+License: MIT
+Project-URL: Homepage, https://github.com/PAWAN1118/Student-Feedback-Flask-DEVops
+Project-URL: Repository, https://github.com/PAWAN1118/Student-Feedback-Flask-DEVops
+Keywords: flask,feedback,education,web,devops
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Flask
+Classifier: Intended Audience :: Education
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: flask>=3.0.0
+Requires-Dist: gunicorn>=22.0.0
+Requires-Dist: click>=8.1.0
+
+# Student Feedback System
+
+A plug-and-play student feedback web application built with Flask.
+Install it, run one command, and you have a fully working feedback portal.
+
+## Installation
+
+```bash
+pip install student-feedback-system
+```
+
+## Quickstart
+
+```bash
+feedback-system run
+# Open http://localhost:5000
+```
+
+## CLI Commands
+
+```bash
+feedback-system run                    # Start app (default port 5000)
+feedback-system run --port 8080        # Custom port
+feedback-system run --debug            # Debug mode
+feedback-system run --config development
+
+feedback-system init-db                # Create database tables
+feedback-system export-csv             # Export all feedback to feedback.csv
+feedback-system reset-db               # ⚠ Delete all data and recreate DB
+feedback-system info                   # Show current configuration
+feedback-system --version              # Show version
+```
+
+## Configuration via Environment Variables
+
+```bash
+export DB_PATH=/var/data/feedback.db
+export SECRET_KEY=your-production-secret
+export PORT=8080
+export PER_PAGE=10
+export APP_NAME="My University Feedback"
+
+feedback-system run
+```
+
+## Configuration via Code
+
+```python
+from feedback_system import create_app
+from feedback_system.config import Config
+
+class MyConfig(Config):
+    DB_PATH    = '/var/data/feedback.db'
+    SECRET_KEY = 'super-secret-key'
+    PER_PAGE   = 10
+    APP_NAME   = 'My University Feedback'
+    APP_TAGLINE= 'Helping Faculty Improve Every Semester'
+
+app = create_app(config=MyConfig)
+app.run(host='0.0.0.0', port=8080)
+```
+
+## Embed in an Existing Flask App
+
+```python
+from flask import Flask
+from feedback_system.routes import feedback_bp
+from feedback_system.database import init_db
+
+app = Flask(__name__)
+app.config['DB_PATH'] = './feedback.db'
+app.config['PER_PAGE'] = 6
+app.secret_key = 'your-secret'
+
+# Mount at /feedback prefix
+app.register_blueprint(feedback_bp, url_prefix='/feedback')
+
+with app.app_context():
+    init_db(app.config['DB_PATH'])
+
+# Dashboard → http://localhost:5000/feedback/
+# Submit   → http://localhost:5000/feedback/submit
+```
+
+## Use the Database Layer Directly
+
+```python
+from feedback_system.database import init_db, add_feedback, get_stats, export_csv
+
+DB = './feedback.db'
+init_db(DB)
+add_feedback(DB, 'Alice', 'DevOps Lab', '5', 'Best lab ever!')
+print(get_stats(DB))
+
+csv_data = export_csv(DB)
+with open('backup.csv', 'w') as f:
+    f.write(csv_data)
+```
+
+## Features
+
+- Submit, view, edit, delete feedback
+- Star ratings (1–5)
+- Search and filter
+- Pagination (configurable per page)
+- Rating distribution chart
+- CSV export via CLI and HTTP
+- Professional corporate UI (navy/gold theme)
+- Health check endpoint at `/health`
+
+## Tech Stack
+
+Flask · SQLite · Gunicorn · Chart.js · Click
+
+## License
+
+MIT

student_feedback_system-1.0.0/README.md

@@ -0,0 +1,117 @@
+# Student Feedback System
+
+A plug-and-play student feedback web application built with Flask.
+Install it, run one command, and you have a fully working feedback portal.
+
+## Installation
+
+```bash
+pip install student-feedback-system
+```
+
+## Quickstart
+
+```bash
+feedback-system run
+# Open http://localhost:5000
+```
+
+## CLI Commands
+
+```bash
+feedback-system run                    # Start app (default port 5000)
+feedback-system run --port 8080        # Custom port
+feedback-system run --debug            # Debug mode
+feedback-system run --config development
+
+feedback-system init-db                # Create database tables
+feedback-system export-csv             # Export all feedback to feedback.csv
+feedback-system reset-db               # ⚠ Delete all data and recreate DB
+feedback-system info                   # Show current configuration
+feedback-system --version              # Show version
+```
+
+## Configuration via Environment Variables
+
+```bash
+export DB_PATH=/var/data/feedback.db
+export SECRET_KEY=your-production-secret
+export PORT=8080
+export PER_PAGE=10
+export APP_NAME="My University Feedback"
+
+feedback-system run
+```
+
+## Configuration via Code
+
+```python
+from feedback_system import create_app
+from feedback_system.config import Config
+
+class MyConfig(Config):
+    DB_PATH    = '/var/data/feedback.db'
+    SECRET_KEY = 'super-secret-key'
+    PER_PAGE   = 10
+    APP_NAME   = 'My University Feedback'
+    APP_TAGLINE= 'Helping Faculty Improve Every Semester'
+
+app = create_app(config=MyConfig)
+app.run(host='0.0.0.0', port=8080)
+```
+
+## Embed in an Existing Flask App
+
+```python
+from flask import Flask
+from feedback_system.routes import feedback_bp
+from feedback_system.database import init_db
+
+app = Flask(__name__)
+app.config['DB_PATH'] = './feedback.db'
+app.config['PER_PAGE'] = 6
+app.secret_key = 'your-secret'
+
+# Mount at /feedback prefix
+app.register_blueprint(feedback_bp, url_prefix='/feedback')
+
+with app.app_context():
+    init_db(app.config['DB_PATH'])
+
+# Dashboard → http://localhost:5000/feedback/
+# Submit   → http://localhost:5000/feedback/submit
+```
+
+## Use the Database Layer Directly
+
+```python
+from feedback_system.database import init_db, add_feedback, get_stats, export_csv
+
+DB = './feedback.db'
+init_db(DB)
+add_feedback(DB, 'Alice', 'DevOps Lab', '5', 'Best lab ever!')
+print(get_stats(DB))
+
+csv_data = export_csv(DB)
+with open('backup.csv', 'w') as f:
+    f.write(csv_data)
+```
+
+## Features
+
+- Submit, view, edit, delete feedback
+- Star ratings (1–5)
+- Search and filter
+- Pagination (configurable per page)
+- Rating distribution chart
+- CSV export via CLI and HTTP
+- Professional corporate UI (navy/gold theme)
+- Health check endpoint at `/health`
+
+## Tech Stack
+
+Flask · SQLite · Gunicorn · Chart.js · Click
+
+## License
+
+MIT

student_feedback_system-1.0.0/feedback_system/__init__.py

@@ -0,0 +1,67 @@
+"""
+feedback_system
+~~~~~~~~~~~~~~~
+A plug-and-play Student Feedback web application built with Flask.
+
+Basic usage:
+    from feedback_system import create_app
+    app = create_app()
+    app.run()
+
+Custom config:
+    from feedback_system import create_app
+    from feedback_system.config import Config
+
+    class MyConfig(Config):
+        DB_PATH    = '/var/data/feedback.db'
+        SECRET_KEY = 'super-secret-key'
+        APP_NAME   = 'My University Feedback'
+
+    app = create_app(config=MyConfig)
+
+String shortcuts:
+    app = create_app(config='production')
+    app = create_app(config='development')
+    app = create_app(config='testing')
+"""
+
+from flask import Flask
+from .config import Config, config_map
+from .database import init_db
+from .routes import feedback_bp
+
+__version__ = '1.0.0'
+__author__  = 'Student DevOps Lab'
+__all__     = ['create_app', 'feedback_bp', '__version__']
+
+
+def create_app(config=None) -> Flask:
+    """
+    Application factory — creates and returns a configured Flask app.
+
+    Args:
+        config: None | Config subclass | 'production' | 'development' | 'testing'
+
+    Returns:
+        Configured Flask application instance.
+    """
+    app = Flask(__name__, template_folder='templates', static_folder='static')
+
+    if config is None:
+        app.config.from_object(Config)
+    elif isinstance(config, str):
+        cfg_class = config_map.get(config)
+        if not cfg_class:
+            raise ValueError(f"Unknown config '{config}'. Choose from: {list(config_map.keys())}")
+        app.config.from_object(cfg_class)
+    else:
+        app.config.from_object(config)
+
+    app.secret_key = app.config['SECRET_KEY']
+
+    with app.app_context():
+        init_db(app.config['DB_PATH'])
+
+    app.register_blueprint(feedback_bp)
+
+    return app

student_feedback_system-1.0.0/feedback_system/cli.py

@@ -0,0 +1,100 @@
+import os
+import click
+from . import create_app, __version__
+from .config import Config
+from .database import init_db, export_csv, reset_db
+
+
+def _env_config():
+    env = os.environ.get('FLASK_ENV', 'production')
+    return env if env in ('development', 'production', 'testing') else 'default'
+
+
+@click.group()
+@click.version_option(version=__version__, prog_name='feedback-system')
+def cli():
+    """Student Feedback System CLI."""
+    pass
+
+
+@cli.command()
+@click.option('--host',   default=None, help='Host to bind (default: 0.0.0.0)')
+@click.option('--port',   default=None, type=int, help='Port (default: 5000)')
+@click.option('--debug',  is_flag=True, default=False, help='Enable debug mode')
+@click.option('--config', 'config_name', default=None, help='development | production | testing')
+def run(host, port, debug, config_name):
+    """Start the Student Feedback web application."""
+    cfg   = config_name or _env_config()
+    app   = create_app(config=cfg)
+    _host = host  or app.config.get('HOST',  '0.0.0.0')
+    _port = port  or app.config.get('PORT',  5000)
+    _dbg  = debug or app.config.get('DEBUG', False)
+
+    click.echo(click.style(f'''
+╔══════════════════════════════════════════╗
+║  Student Feedback System v{__version__:<13}  ║
+╠══════════════════════════════════════════╣
+║  URL    : http://{_host}:{_port}
+║  DB     : {app.config["DB_PATH"]}
+║  Config : {cfg}
+╚══════════════════════════════════════════╝
+    ''', fg='green'))
+
+    app.run(host=_host, port=_port, debug=_dbg)
+
+
+@cli.command('init-db')
+@click.option('--db-path', default=None, help='Path to the SQLite database')
+def init_db_cmd(db_path):
+    """Initialise the database."""
+    path = db_path or os.environ.get('DB_PATH', Config.DB_PATH)
+    init_db(path)
+    click.echo(click.style(f'✓ Database initialised at: {path}', fg='green'))
+
+
+@cli.command('export-csv')
+@click.option('--db-path', default=None)
+@click.option('--output',  default='feedback.csv')
+def export_cmd(db_path, output):
+    """Export all feedback to a CSV file."""
+    path = db_path or os.environ.get('DB_PATH', Config.DB_PATH)
+    data = export_csv(path)
+    with open(output, 'w', newline='', encoding='utf-8') as f:
+        f.write(data)
+    lines = len(data.strip().split('\n')) - 1
+    click.echo(click.style(f'✓ Exported {lines} records to: {output}', fg='green'))
+
+
+@cli.command('reset-db')
+@click.option('--db-path', default=None)
+@click.confirmation_option(prompt='⚠  This will DELETE all feedback data. Continue?')
+def reset_db_cmd(db_path):
+    """Drop and recreate the database. ALL DATA WILL BE LOST."""
+    path = db_path or os.environ.get('DB_PATH', Config.DB_PATH)
+    reset_db(path)
+    click.echo(click.style(f'✓ Database reset at: {path}', fg='yellow'))
+
+
+@cli.command()
+def info():
+    """Show current configuration."""
+    cfg = Config()
+    click.echo(f'''
+Student Feedback System v{__version__}
+{"─" * 38}
+DB_PATH    : {cfg.DB_PATH}
+HOST       : {cfg.HOST}
+PORT       : {cfg.PORT}
+DEBUG      : {cfg.DEBUG}
+PER_PAGE   : {cfg.PER_PAGE}
+APP_NAME   : {cfg.APP_NAME}
+SECRET_KEY : {'*** (set)' if cfg.SECRET_KEY != 'dev-secret-change-in-production' else '⚠  using default!'}
+    ''')
+
+
+def main():
+    cli()
+
+
+if __name__ == '__main__':
+    main()

student_feedback_system-1.0.0/feedback_system/config.py

@@ -0,0 +1,34 @@
+import os
+
+
+class Config:
+    SECRET_KEY  = os.environ.get('SECRET_KEY',  'dev-secret-change-in-production')
+    DB_PATH     = os.environ.get('DB_PATH',     os.path.join(os.getcwd(), 'feedback.db'))
+    PER_PAGE    = int(os.environ.get('PER_PAGE', 6))
+    HOST        = os.environ.get('HOST',        '0.0.0.0')
+    PORT        = int(os.environ.get('PORT',    5000))
+    DEBUG       = os.environ.get('DEBUG',       'false').lower() == 'true'
+    APP_NAME    = os.environ.get('APP_NAME',    'Student Feedback System')
+    APP_TAGLINE = os.environ.get('APP_TAGLINE', 'Academic Excellence Portal')
+
+
+class DevelopmentConfig(Config):
+    DEBUG   = True
+    DB_PATH = os.path.join(os.getcwd(), 'feedback_dev.db')
+
+
+class ProductionConfig(Config):
+    DEBUG = False
+
+
+class TestingConfig(Config):
+    TESTING = True
+    DB_PATH = ':memory:'
+
+
+config_map = {
+    'development': DevelopmentConfig,
+    'production':  ProductionConfig,
+    'testing':     TestingConfig,
+    'default':     Config,
+}

student_feedback_system-1.0.0/feedback_system/database.py

@@ -0,0 +1,126 @@
+import sqlite3
+import os
+import csv
+import io
+from datetime import datetime
+
+
+def _connect(db_path: str) -> sqlite3.Connection:
+    if db_path != ':memory:':
+        os.makedirs(os.path.dirname(os.path.abspath(db_path)), exist_ok=True)
+    conn = sqlite3.connect(db_path)
+    conn.row_factory = sqlite3.Row
+    return conn
+
+
+def init_db(db_path: str) -> None:
+    conn = _connect(db_path)
+    conn.execute('''
+        CREATE TABLE IF NOT EXISTS feedback (
+            id           INTEGER PRIMARY KEY AUTOINCREMENT,
+            name         TEXT    NOT NULL,
+            course       TEXT,
+            rating       TEXT,
+            message      TEXT    NOT NULL,
+            submitted_at TEXT    DEFAULT (datetime('now'))
+        )
+    ''')
+    conn.commit()
+    conn.close()
+
+
+def add_feedback(db_path, name, course, rating, message):
+    conn = _connect(db_path)
+    conn.execute(
+        'INSERT INTO feedback (name, course, rating, message, submitted_at) VALUES (?,?,?,?,?)',
+        (name, course, rating, message, datetime.now().strftime('%Y-%m-%d %H:%M:%S'))
+    )
+    conn.commit()
+    conn.close()
+
+
+def get_paginated_feedback(db_path, page, per_page):
+    conn   = _connect(db_path)
+    total  = conn.execute('SELECT COUNT(*) FROM feedback').fetchone()[0]
+    offset = (page - 1) * per_page
+    rows   = conn.execute(
+        'SELECT * FROM feedback ORDER BY submitted_at DESC LIMIT ? OFFSET ?',
+        (per_page, offset)
+    ).fetchall()
+    conn.close()
+    return [dict(r) for r in rows], total
+
+
+def get_all_feedback(db_path):
+    conn = _connect(db_path)
+    rows = conn.execute('SELECT * FROM feedback ORDER BY submitted_at DESC').fetchall()
+    conn.close()
+    return [dict(r) for r in rows]
+
+
+def get_feedback_by_id(db_path, feedback_id):
+    conn = _connect(db_path)
+    row  = conn.execute('SELECT * FROM feedback WHERE id = ?', (feedback_id,)).fetchone()
+    conn.close()
+    return dict(row) if row else None
+
+
+def update_feedback(db_path, feedback_id, name, course, rating, message):
+    conn = _connect(db_path)
+    conn.execute(
+        'UPDATE feedback SET name=?, course=?, rating=?, message=? WHERE id=?',
+        (name, course, rating, message, feedback_id)
+    )
+    conn.commit()
+    conn.close()
+
+
+def delete_feedback(db_path, feedback_id):
+    conn = _connect(db_path)
+    conn.execute('DELETE FROM feedback WHERE id = ?', (feedback_id,))
+    conn.commit()
+    conn.close()
+
+
+def search_feedback(db_path, query):
+    conn = _connect(db_path)
+    q    = f'%{query}%'
+    rows = conn.execute(
+        'SELECT * FROM feedback WHERE name LIKE ? OR course LIKE ? OR message LIKE ? ORDER BY submitted_at DESC',
+        (q, q, q)
+    ).fetchall()
+    conn.close()
+    return [dict(r) for r in rows]
+
+
+def get_stats(db_path):
+    conn   = _connect(db_path)
+    total  = conn.execute('SELECT COUNT(*) FROM feedback').fetchone()[0]
+    avg    = conn.execute(
+        "SELECT ROUND(AVG(CAST(rating AS REAL)),1) FROM feedback WHERE rating != '' AND rating IS NOT NULL"
+    ).fetchone()[0]
+    dist   = conn.execute(
+        "SELECT rating, COUNT(*) as count FROM feedback WHERE rating != '' AND rating IS NOT NULL GROUP BY rating ORDER BY rating"
+    ).fetchall()
+    recent = conn.execute(
+        "SELECT COUNT(*) FROM feedback WHERE submitted_at >= datetime('now', '-7 days')"
+    ).fetchone()[0]
+    conn.close()
+    return {'total': total, 'avg_rating': avg or 0, 'distribution': [dict(r) for r in dist], 'recent': recent}
+
+
+def export_csv(db_path):
+    rows   = get_all_feedback(db_path)
+    output = io.StringIO()
+    writer = csv.DictWriter(output, fieldnames=['id','name','course','rating','message','submitted_at'])
+    writer.writeheader()
+    writer.writerows(rows)
+    return output.getvalue()
+
+
+def reset_db(db_path):
+    conn = _connect(db_path)
+    conn.execute('DROP TABLE IF EXISTS feedback')
+    conn.commit()
+    conn.close()
+    init_db(db_path)

student_feedback_system-1.0.0/feedback_system/routes.py

@@ -0,0 +1,112 @@
+from flask import Blueprint, render_template, request, redirect, url_for, flash, current_app, Response, jsonify
+from .database import (
+    add_feedback, get_feedback_by_id, update_feedback,
+    delete_feedback, search_feedback, get_stats,
+    get_paginated_feedback, export_csv
+)
+
+feedback_bp = Blueprint(
+    'feedback', __name__,
+    template_folder='templates',
+    static_folder='static',
+    static_url_path='/feedback/static'
+)
+
+
+def _db():
+    return current_app.config['DB_PATH']
+
+
+def _per_page():
+    return current_app.config.get('PER_PAGE', 6)
+
+
+@feedback_bp.route('/')
+def index():
+    page     = request.args.get('page', 1, type=int)
+    query    = request.args.get('q', '').strip()
+    per_page = _per_page()
+
+    if query:
+        feedbacks = search_feedback(_db(), query)
+        total     = len(feedbacks)
+        start     = (page - 1) * per_page
+        feedbacks = feedbacks[start:start + per_page]
+    else:
+        feedbacks, total = get_paginated_feedback(_db(), page, per_page)
+
+    total_pages = max(1, (total + per_page - 1) // per_page)
+
+    return render_template(
+        'index.html',
+        feedbacks=feedbacks,
+        stats=get_stats(_db()),
+        page=page,
+        total_pages=total_pages,
+        total=total,
+        query=query,
+        app_name=current_app.config.get('APP_NAME', 'Student Feedback System'),
+        app_tagline=current_app.config.get('APP_TAGLINE', 'Academic Excellence Portal'),
+    )
+
+
+@feedback_bp.route('/submit', methods=['GET', 'POST'])
+def submit():
+    if request.method == 'POST':
+        name    = request.form.get('name', '').strip()
+        course  = request.form.get('course', '').strip()
+        rating  = request.form.get('rating', '').strip()
+        message = request.form.get('message', '').strip()
+        if not name or not message:
+            flash('Name and feedback message are required!', 'error')
+            return render_template('feedback.html', form_data=request.form)
+        add_feedback(_db(), name, course, rating, message)
+        flash('Feedback submitted successfully!', 'success')
+        return redirect(url_for('feedback.index'))
+    return render_template('feedback.html', form_data={})
+
+
+@feedback_bp.route('/edit/<int:feedback_id>', methods=['GET', 'POST'])
+def edit(feedback_id):
+    fb = get_feedback_by_id(_db(), feedback_id)
+    if not fb:
+        flash('Feedback not found.', 'error')
+        return redirect(url_for('feedback.index'))
+    if request.method == 'POST':
+        name    = request.form.get('name', '').strip()
+        course  = request.form.get('course', '').strip()
+        rating  = request.form.get('rating', '').strip()
+        message = request.form.get('message', '').strip()
+        if not name or not message:
+            flash('Name and feedback message are required!', 'error')
+            return render_template('edit.html', fb=fb)
+        update_feedback(_db(), feedback_id, name, course, rating, message)
+        flash('Feedback updated successfully!', 'success')
+        return redirect(url_for('feedback.index'))
+    return render_template('edit.html', fb=fb)
+
+
+@feedback_bp.route('/delete/<int:feedback_id>', methods=['POST'])
+def delete(feedback_id):
+    delete_feedback(_db(), feedback_id)
+    flash('Feedback deleted.', 'success')
+    return redirect(url_for('feedback.index'))
+
+
+@feedback_bp.route('/api/stats')
+def api_stats():
+    return jsonify(get_stats(_db()))
+
+
+@feedback_bp.route('/api/export.csv')
+def api_export():
+    return Response(
+        export_csv(_db()),
+        mimetype='text/csv',
+        headers={'Content-Disposition': 'attachment; filename=feedback.csv'}
+    )
+
+
+@feedback_bp.route('/health')
+def health():
+    return jsonify({'status': 'ok', 'message': 'Feedback System running'}), 200