Employee Management System | By StudyVatika - Setup Instructions

Overview

The StudyVatika Employee Management System is a comprehensive Python-based application for managing employee records. This improved version uses SQLite database for better portability and includes enhanced features.

Author: Arbind Singh
Email: admin@studyvatika.com
Organization: StudyVatika
Version: 2.0 (SQLite Edition)

Features

• ✅ SQLite Database - No external database server required
• ✅ Complete CRUD Operations - Create, Read, Update, Delete employees
• ✅ Salary Slip Generation - Automated salary calculations with HRA, DA, IT, NPS
• ✅ Input Validation - Comprehensive validation for all user inputs
• ✅ Error Handling - Robust error handling with meaningful messages
• ✅ StudyVatika Branding - Professional branding throughout the application
• ✅ Cross-Platform - Works on Windows, Linux, and macOS

System Requirements

Python Version

• Python 3.6 or higher (recommended: Python 3.8+)
• Check your Python version: python --version

Operating System

• Windows 10/11
• Linux (Ubuntu, CentOS, etc.)
• macOS 10.14+

Hardware Requirements

• RAM: Minimum 512 MB (1 GB recommended)
• Storage: 50 MB free space
• Processor: Any modern processor (x86/x64)

Installation Guide

Step 1: Verify Python Installation

Open your command prompt/terminal and check if Python is installed:

python --version

If Python is not installed, download it from: https://www.python.org/downloads/

Step 2: Download the Application

Download all the following files to a single folder:

• studyvatika_ems.py (Main application file)
• database_manager.py (Database management module)
• instruction.md (This instruction file)

Step 3: No Additional Dependencies Required

This application uses only Python standard library modules:

• sqlite3 (built-in with Python)
• os (built-in with Python)
• sys (built-in with Python)
• typing (built-in with Python 3.5+)

No pip installations required!

Step 4: Verify File Structure

Your project folder should contain:

StudyVatika_EMS/
├── studyvatika_ems.py
├── database_manager.py
├── instruction.md
└── studyvatika_employees.db (created automatically on first run)

Running the Application

Method 1: Direct Execution (Recommended)

1. Open command prompt/terminal
2. Navigate to the project folder:

   cd path/to/StudyVatika_EMS
   

3. Run the application:

   python studyvatika_ems.py
   

Method 2: Using Python Module

python -m studyvatika_ems

First Run

On the first run, the application will:

1. Create the SQLite database file (studyvatika_employees.db)
2. Initialize the database schema
3. Display the StudyVatika welcome screen

Application Usage Guide

Main Menu Options

1. SHOW EMPLOYEE LIST - Display all employees in a formatted table
2. ADD NEW EMPLOYEE - Add a new employee with validation
3. SEARCH EMPLOYEE - Find an employee by ID
4. EDIT EMPLOYEE - Modify employee department and salary
5. DELETE EMPLOYEE - Remove an employee (with confirmation)
6. GENERATE SALARY SLIP - Create detailed salary slip with calculations
7. CONTACT US - View system information and contact details
8. EXIT - Close the application safely

Adding Employees

When adding a new employee, provide:

• Employee ID: Unique positive integer
• Name: Employee full name (max 50 characters)
• Department: Department name (max 30 characters)
• Salary: Monthly salary (positive integer, max ₹1 crore)

Salary Slip Calculations

The system automatically calculates:

• HRA (House Rent Allowance): 12% of basic salary
• DA (Dearness Allowance): 15% of basic salary
• Income Tax: Fixed ₹1,000 (simplified)
• NPS (National Pension Scheme): 10% of (basic + HRA)
• Gross Salary: Basic + HRA + DA + NPS
• Net Salary: Gross - (Income Tax + NPS)

Data Validation

The system validates:

• Employee IDs must be positive integers
• Names and departments cannot be empty
• Salaries must be reasonable amounts
• Duplicate employee IDs are prevented

Database Information

Database File

• Location: studyvatika_employees.db (in application folder)
• Type: SQLite 3 database
• Backup: Simply copy the .db file to backup your data

Database Schema

CREATE TABLE emp (
    empno INTEGER PRIMARY KEY,
    name TEXT NOT NULL,
    dept TEXT NOT NULL,
    salary INTEGER NOT NULL,
    created_date TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
    updated_date TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);

Sample Data

The system can be populated with sample data using the included populate_sample_data.py script:

python populate_sample_data.py

Troubleshooting

Common Issues and Solutions

Issue 1: "Python is not recognized"

Solution:

• Install Python from python.org
• Add Python to system PATH during installation
• Restart command prompt after installation

Issue 2: "No module named 'database_manager'"

Solution:

• Ensure database_manager.py is in the same folder as studyvatika_ems.py
• Run the application from the correct directory

Issue 3: Database permission errors

Solution:

• Ensure the application folder has write permissions
• Run as administrator if necessary (Windows)
• Check folder permissions (Linux/Mac)

Issue 4: Application exits immediately

Solution:

• Check if all required files are present
• Verify Python version (3.6+)
• Run from command line to see error messages

Issue 5: Display formatting issues

Solution:

• Ensure terminal/command prompt supports Unicode characters
• Use Windows Terminal or modern terminal emulator
• Adjust terminal width to at least 80 characters

Error Messages

Advanced Usage

Backing Up Data

To backup your employee data:

1. Copy studyvatika_employees.db to a safe location
2. The database file contains all employee records

Restoring Data

To restore from backup:

1. Replace studyvatika_employees.db with your backup file
2. Restart the application

Database Queries (Advanced Users)

You can query the database directly using SQLite tools:

sqlite3 studyvatika_employees.db

Common queries:

-- View all employees
SELECT * FROM emp;

-- Count employees by department
SELECT dept, COUNT(*) FROM emp GROUP BY dept;

-- Find highest paid employee
SELECT * FROM emp ORDER BY salary DESC LIMIT 1;

Performance Notes

• The application can handle thousands of employee records efficiently
• SQLite database provides excellent performance for small to medium datasets
• Database file size grows approximately 1KB per 100 employee records

Security Considerations

• Database uses parameterized queries to prevent SQL injection
• Input validation prevents malicious data entry
• Local database file - no network security concerns
• Sensitive salary data is handled securely

Version History

Version 2.0 (Current)

• Migrated from MySQL to SQLite
• Added comprehensive input validation
• Improved error handling
• Enhanced StudyVatika branding
• Added detailed documentation
• Cross-platform compatibility

Version 1.0 (Legacy)

• MySQL database dependency
• Basic CRUD operations
• Limited error handling

Support and Contact

For technical support or questions:

Author: Arbind Singh
Email: admin@studyvatika.com
Organization: StudyVatika

Reporting Issues

When reporting issues, please include:

1. Operating system and version
2. Python version
3. Error message (if any)
4. Steps to reproduce the issue

License

MIT License

Copyright (c) 2024 StudyVatika - Arbind Singh

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Attribution Requirements

When using, modifying, or distributing this software, please provide proper attribution:

• Original Author: Arbind Singh
• Organization: StudyVatika
• Email: admin@studyvatika.com
• Project: StudyVatika Employee Management System

Usage Rights

You are free to:

• ✅ Use - Use the software for personal, educational, or commercial purposes
• ✅ Modify - Modify the source code to suit your needs
• ✅ Distribute - Share the original or modified versions
• ✅ Sublicense - Include in your own projects with different licenses
• ✅ Sell - Use in commercial products or services

Attribution Examples

When redistributing or modifying, include attribution such as:

In documentation:

Based on StudyVatika Employee Management System
Original Author: Arbind Singh (admin@studyvatika.com)
Organization: StudyVatika

In source code:

# Based on StudyVatika Employee Management System
# Original Author: Arbind Singh <admin@studyvatika.com>
# Organization: StudyVatika
# Licensed under MIT License

---

Thank you for using StudyVatika Employee Management System!

This project is open source and free to use under the MIT License.