Skip to content

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 

Repository files navigation

AIRION

AIRION is a study companion built around the idea that preparation is a battle won before it begins. It is a Python-based terminal app that helps students choose topics, track study sessions, and visualize progress over time. The experience is designed to feel like a personal coach guiding you through the next study session.

Story

Imagine a student named Aarav, standing at his desk with a stack of books and a noisy mind. He wants to study smarter, not harder, but every time he opens his notebook, he gets distracted by the next topic or the feeling that he is losing time.

One evening, Aarav created AIRION. He gave it a mission: make studying feel like a purpose-driven exercise where every session is clear, every break is meaningful, and every score tells a story. When Ari logs in, the terminal welcomes him with a bold title and the promise that some battles are won in the terminal before they are fought in the exam hall.

AIRION does not only count minutes. It helps Ari pick a subject, drill the right chapter, manage breaks responsibly, and then offers charts to show where he spent his study energy. The result is a study habit that feels organized, supported, and rewarding.

Use this README as your guide to install AIRION, connect the database, and start using it to turn your study time into a clear journey.

What AIRION Does

  • Provides a decorated terminal home screen and menu system
  • Lets users log in or create a new account with masked password entry
  • Loads topics from topics.csv and guides students through:
    • subject selection
    • branch/section selection
    • chapter/topic selection
  • Tracks study sessions and optional breaks with a timer and progress bar
  • Saves session history in a MySQL database
  • Displays study stats and charts using Matplotlib

Files in this Project

  • airion.py - the main Python program for AIRION
  • db_structure.sql - the SQL schema for setting up the MySQL database
  • topics.csv - the list of subjects, branches, and chapters available for study
  • README.md - this guide

Requirements

AIRION runs on Windows and uses:

  • Python 3.x
  • pandas
  • sqlalchemy
  • pymysql
  • matplotlib

The project also uses the Windows-only msvcrt module for masked password input.

Installation Guide

  1. Install Python 3 if you do not already have it.

  2. Open PowerShell and navigate to the project folder:

cd "c:\Users\raksh\Documents\PROJECTS\AIRION"
  1. Create and activate a virtual environment (recommended):
python -m venv .venv
.\.venv\Scripts\Activate.ps1
  1. Install the required packages:
pip install pandas sqlalchemy pymysql matplotlib

Database Setup

AIRION expects a local MySQL database named airion and a credentials table. Use the SQL file to create the required schema.

  1. Open your MySQL client and run the commands in db_structure.sql.

  2. Example commands for MySQL:

CREATE DATABASE AIRION;
USE AIRION;
SOURCE c:/Users/raksh/Documents/PROJECTS/AIRION/db_structure.sql;
  1. If you prefer, execute the SQL statements directly from a MySQL shell.

  2. Confirm the database connection settings in airion.py:

engine = engine('mysql+pymysql://root:12345@localhost:3306/airion')

If your MySQL username, password, or host is different, update this connection string before running the app.

How to Run AIRION

With the virtual environment active and dependencies installed, run:

python airion.py

When you launch the app:

  • You will see the AIRION welcome screen
  • Create a new account or log in with an existing username
  • Choose Concept Drill to select a subject, branch, and chapter
  • Use the timed study session and optional breaks
  • Rate your productivity after each session
  • View study stats with charts from View Stats

Project Flow

  1. homepage() prints the welcome banner
  2. login() asks for username and password, or creates a new account
  3. topic_selector() loads topics.csv and asks you to pick a subject, branch, and chapter
  4. sessions_tracker() records your session duration and break plan
  5. concept_drill() saves the study session to the MySQL database
  6. stats() shows subject distribution and weekly study duration charts

Notes and Tips

  • topics.csv contains the subject tree for Mathematics, Physics, and Chemistry.
  • AIRION stores session details in the STUDY_SESSIONS table.
  • The timer uses sounds and a live progress bar. If you interrupt with Ctrl+C, it can resume the timer.
  • Keep the database running while using the app.
  • If the database connection fails, check your MySQL service, credentials, and connection string.

Study Story: How to Use AIRION

Think of AIRION as your study ally. Each time you open it:

  • Pick a subject and a focused chapter instead of juggling half a dozen ideas.
  • Set a realistic study goal, then break it into sessions if needed.
  • Use the timer to stay intentional — not just busy.
  • At the end of the session, rate your productivity and let the app keep a record.
  • Review the charts later to see where you invested your attention.

With AIRION, studying becomes a series of small victories. The more you use it, the more the data helps you understand what topics need more time and what study habits are working.

Future Improvements

You can extend AIRION with:

  • question-based drills and quizzes
  • more advanced progress analytics
  • support for other operating systems
  • richer topic categories and custom subjects
  • a web or GUI interface

Thank you for building AIRION. Use it as your guide, keep your study sessions disciplined, and let the analytics help you grow.

About

CLI type study tracker

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages