https://github.com/randomsearch18/pupil-management-system

"Mr Leeman's System": A pupil management system for Tree Road School
https://github.com/randomsearch18/pupil-management-system

Last synced: about 1 month ago
JSON representation

"Mr Leeman's System": A pupil management system for Tree Road School

• Host: GitHub
• URL: https://github.com/randomsearch18/pupil-management-system
• Owner: RandomSearch18
• Created: 2023-09-26T12:11:28.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-11-27T16:03:53.000Z (over 2 years ago)
• Last Synced: 2025-06-02T19:23:01.342Z (about 1 year ago)
• Language: Python
• Homepage: https://replit.com/@RandomSearch/Pupil-Management-System
• Size: 225 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Mr Leeman's System

A menu-based tool for viewing, searching, and managing pupils' details, made using Python. In other words, it's a pupil management system.

## Screenshots

![Screenshot of the program running in a terminal. A new account is being created, with inputs and descriptive text for the Username and Password fields](https://github.com/RandomSearch18/pupil-management-system/assets/101704343/3e8c29a3-7515-4798-9e0c-615c4cf28290)

![Screenshot of the program running in a terminal. A report for students with surnames beginning with H is being viewed.](https://github.com/RandomSearch18/pupil-management-system/assets/101704343/c60e9ef7-84c2-4f16-b80c-3d87f90d6404)

![Screenshot of the program running in a terminal. The user has asked for information about student #3, and their details have been printed.](https://github.com/RandomSearch18/pupil-management-system/assets/101704343/df6805ed-efc8-478a-b88e-cbcf7ecd5b56)

## Usage

Tested with Python 3.9 and 3.10. Will probably work with newer versions too. This project uses [Poetry](https://python-poetry.org/docs/) to manage Python libraries.

I've tested the program on Linux, Windows and Android, and it should support anything that can run Python. For the best experience, ensure your terminal supports colored and formatted text (ANSI color codes).

```bash

$ poetry install

$ poetry run python main.py

```

Alternatively, you can manually install [the required Python libraries](#libraries) using `pip`.

## Documentation

### Libraries

This program uses a few libraries to provide functionality that I wouldn't want to implement myself, like password hashing and regular expression support.

- `bcrypt` - Used for secure password storage with its password hashing features

- `regex` - Provides regular expression functionality with more features than the built-in `re` module, which is important for implementing robust validation

- `colorama` - Provides shorthands for terminal color codes, and makes sure they work on all platforms

- `phonenumbers` - The de-facto standard library for parsing and validating (inter)national phone number formats. This lets the program accurately and consistently work with any phone number.