KO
|
EN
gitlite — search
Search
#python
#java
#python3
#arduino
#golang
#machine-learning
#rust
#html
#flask
#javascript
#seismology
#nodejs
student-management-bash
★ 19
Open GitHub ↗
No description available.
Download README (.md)
Explore Similar Repositories
TZGeneration
:
No description available.
ProGearSDK
:
A modern game engine SDK for the NeoGeo AES/MVS.
imgui_fc_visualizer
:
Try make a simple FC/NES audio visualizer
TensorCardEmulator
:
NFC Card Emulator for Google Pixel (Tensor only)
Cloudflare-ProxyX
:
基于 Cloudflare Workers 的 GitHub 和 Docker 加速服务，自动生成加速链接与命令。
// repository documentation
Was this content helpful?
★ 0
(0 ratings)
Select Rating:
★
★
★
★
★
Submit Feedback
Recent Feedback
×
Download README
Do you want to download the
README.md
file for
student-management-bash
?
Download (.md)
# 🎓 Student Management System v4.1.0 [](https://opensource.org/licenses/MIT) [](https://www.gnu.org/software/bash/) []() [](https://github.com/Mehdi-dev-sudo) [](mailto:mehdi.khorshidi333@gmail.com) A production-grade, thread-safe student management system written in pure Bash. Features enterprise-level error handling, RFC 4180 compliant CSV operations, and comprehensive logging. --- ## ✨ Features ### 🔒 Enterprise-Grade Reliability - **Thread-safe operations** with directory-based locking - **RFC 4180 compliant** CSV parsing (handles quotes, commas, newlines) - **Atomic writes** with retry logic - **Single instance protection** via PID file - **POSIX-compatible** (no GNU-specific dependencies) ### 📊 Core Functionality - ➕ **CRUD Operations**: Add, Edit, Delete, View students - 🔍 **Search**: Multi-field case-insensitive search (name, code, email) - 📈 **Statistics**: GPA distribution, averages, rankings - 📤 **Export**: JSON and clean CSV export with metadata ### 🛡️ Security & Validation - ✅ Input sanitization (removes control characters) - ✅ Email validation (RFC 5322 compliant) - ✅ Phone number validation (Iranian format) - ✅ Student code uniqueness checks (8-10 digits) - ✅ GPA validation (0-20 range) ### 🔧 System Management - 💾 **Automatic backups** with rotation (keeps last 10) - 📜 **Multi-level logging** (DEBUG, INFO, WARN, ERROR) - ⚡ **Performance metrics** tracking - 🎨 **Colorized output** with UTF-8 icons - 🔄 **Backup restore** with safety snapshot --- ## 📋 Requirements ### System Requirements - **OS**: Linux or macOS - **Bash**: 4.4 or higher - **Tools**: `awk`, `sed`, `grep`, `flock` (util-linux) ### Check dependencies: ```bash ./student_management.sh --check-deps ``` --- ## 🚀 Quick Start ### 1. Clone the repository ```bash git clone https://github.com/Mehdi-dev-sudo/student-management-bash.git cd student-management-bash ``` ### 2. Make executable ```bash chmod +x student_management.sh chmod +x tests/run_tests.sh ``` ### 3. Run ```bash ./student_management.sh ``` ### 4. Run tests ```bash ./tests/run_tests.sh ``` --- ## 📖 Usage ### Basic Commands ```bash # Run normally ./student_management.sh # Show help ./student_management.sh --help # Show version ./student_management.sh --version # Enable debug mode ./student_management.sh --debug # Enable performance metrics ./student_management.sh --performance # Export database to clean CSV ./student_management.sh --export-csv # Check dependencies ./student_management.sh --check-deps # Initialize/repair system directories ./student_management.sh --init ``` ### Configuration Edit `~/.config/student-mgmt/config`: ```bash # Maximum number of backups to keep MAX_BACKUPS=10 # Lock timeout in seconds LOCK_TIMEOUT=10 # Maximum retry attempts for I/O operations MAX_RETRIES=3 # Logging level (DEBUG, INFO, WARN, ERROR) LOG_LEVEL=INFO # Enable performance metrics ENABLE_PERFORMANCE_METRICS=false ``` --- ### Main Menu ```bash ╔═══════════════════════════════════════════════════╗ ║ ║ ║ 🎓 Student Management System v4.1.0 ║ ║ Enterprise Grade Edition ║ ║ ║ ╚═══════════════════════════════════════════════════╝ 📝 CRUD Operations: 1) ➕ Add New Student 2) 📋 Display All Students 3) 👤 View Student Details 4) ✏️ Edit Student 5) 🗑️ Delete Student 🔍 Search & Reports: 6) 🔍 Search Students 7) 📊 Show Statistics 8) 📤 Export to JSON ⚙️ System: 9) 💾 Create Manual Backup 10) 🔄 Restore Backup 11) 📜 View Logs 0) 🚪 Exit ``` --- ## 🏗️ Architecture ### File Structure ``` ~/.local/share/student-mgmt/ ├── students.csv # Main database └── backups/ # Automatic backups ├── students_20250929_143022_auto.csv └── students_20250929_120000_manual.csv ~/.config/student-mgmt/ └── config # User configuration ~/.cache/student-mgmt/ # Cache directory ~/.local/share/student-mgmt/ ├── app.log # Application logs └── .lock/ # Lock directory ``` ### CSV Format (RFC 4180) ```csv ID,StudentCode,FirstName,LastName,Email,Phone,GPA,RegistrationDate 1,STU001,John,Doe,john@example.com,09123456789,18.50,2025-11-29 14:30:22 2,STU002,Jane,Smith,jane@example.com,09187654321,16.75,2025-11-29 14:31:05 ``` ### Key Technical Details #### 1. Thread-Safe Operations ```bash acquire_lock() { while ! mkdir "$LOCK_FILE" 2>/dev/null; do sleep 1 done } ``` #### 2. RFC 4180 CSV Parsing ```bash awk 'BEGIN { FPAT = "([^,]*)|(\"([^\"]|\"\")*\")" }' ``` #### 3. Atomic Writes with Retry ```bash atomic_write() { local temp_file temp_file="$(mktemp "${target}.XXXXXX")" cat > "$temp_file" && mv "$temp_file" "$target" } ``` --- ## 🧪 Testing ```bash # Run all tests ./tests/run_tests.sh # Run individual test suites ./tests/test_validation.sh ./tests/test_csv_parsing.sh ``` The test suite covers: - GPA validation (boundary values, invalid input) - Email validation (RFC 5322 pattern) - Phone validation (Iranian format with/without separators) - Student code validation (length, format) - Input sanitization (trim, control chars) - CSV escaping (quotes, commas, special chars) - CSV parsing (simple, quoted fields, multi-line) --- ## 🐛 Troubleshooting ### Common Issues #### 1. Permission Denied ```bash chmod +x student_management.sh ``` #### 2. Lock Timeout ```bash # Increase timeout in config LOCK_TIMEOUT=30 ``` #### 3. Bash Version Too Old ```bash # Check version bash --version # Upgrade (Ubuntu/Debian) sudo apt update && sudo apt install --only-upgrade bash ``` #### 4. Corrupted Database ```bash # Restore from backup ./student_management.sh # Select option 10 (Restore Backup) ``` --- ## 📊 Performance | Operation | Time (1000 records) | |-----------|---------------------| | Add | ~0.05s | | Search | ~0.02s | | Edit | ~0.08s | | Delete | ~0.06s | | Export JSON | ~0.15s | *Tested on: Intel i5-8250U, 8GB RAM, SSD* --- ## 🤝 Contributing Contributions are welcome! Please read [CONTRIBUTING.md](CONTRIBUTING.md) first. ### Development Setup 1. Fork the repository 2. Create a feature branch 3. Make your changes 4. Run tests: `./tests/run_tests.sh` 5. Submit a pull request ### Code Style - Use 4 spaces for indentation - Follow existing naming conventions - Keep functions focused on single responsibility --- ## 📝 Changelog See [CHANGELOG.md](CHANGELOG.md) for version history. ### v4.1.0 (2026-07-25) - Unified locking mechanism (directory-based only) - POSIX-compatible backup operations - Test suite with validation and CSV parsing tests - Case-insensitive search (portable) - Clean CSV export (--export-csv) - Fixed mixed locking, missing timers, and URL in help ### v4.0.0 (2025-11-29) - CLI arguments (--help, --version, --debug) - Performance metrics and enhanced error handling - Single instance protection --- ## 📄 License This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. --- ## 👨💻 Author **Mehdi Khorshidi Far** - GitHub: [@Mehdi-dev-sudo](https://github.com/Mehdi-dev-sudo) - Email: mehdi.khorshidi333@gmail.com - Location: Amol, Iran --- ## 🙏 Acknowledgments - Inspired by modern CLI best practices - Built with ❤️ using pure Bash - Special thanks to the Bash community --- ## 📚 Additional Resources - [Bash Best Practices](https://mywiki.wooledge.org/BashGuide/Practices) - [RFC 4180 (CSV Format)](https://tools.ietf.org/html/rfc4180) - [AWK Programming Guide](https://www.gnu.org/software/gawk/manual/) --- ## ⭐ Star History If you find this project useful, please consider giving it a star! [](https://star-history.com/#Mehdi-dev-sudo/student-management-bash&Date)
