Skip to main content

Simple login script

Project description

Simple file-based authentication system with messaging, permissions, and moderation.

DocumentationReport BugRequest Feature


🌟 Why This Project?

  • Fully customizable and easy to extend
  • Includes real-world features (messaging, permissions, banning, etc.)
  • Lightweight — no database required

✨ Features

  • 🔑 User authentication (login & signup)
  • 🔒 Password hashing using SHA-256
  • 📬 User-to-user messaging
  • 📥 Mailbox system (read, send, clear)
  • 🛡️ Permission system (tiers 1–5)
  • ⬆️ User promotion system
  • 🚫 User banning system
  • ❌ Account deletion
  • 🛠️ Initial setup mode

🔐 System Overview

This system uses plain text files as a simple, lightweight database.

📁 Data Storage

  • users.txt → Stores usernames and hashed passwords
  • bannedusers.txt → Stores banned usernames
  • user_(id).txt → Stores user permissions
  • mailbox_(username).txt → Stores user messages

🛠️ First-Time Setup

download the program by running:

pip install simple-login-system==0.1.3

Run it by typing

python -m simplelogin.login

Run the program and type:

setup

!DISCLAIMER!

Setup user can only be used for promoting and some default features

Make a different user and promote it to use more features

This will:

  • Create a default admin account
  • Grant admin promotion permissions

Default credentials:

  • Username: setup
  • Password: setup

⚠️ Important: Delete this account after creating your own admin account and give it perms.


🧑‍💻 Usage

At startup, choose:

  • log in
  • sign up
  • setup

📜 Commands

Command Description
help Show all commands
date/time Shows the current date and time
message Send a message to a user
readmail Read your mailbox
promote Promote a user (requires permission)
ban Ban a user
blacklist Blacklists a username from use for a new account
deleteaccount Delete your account
changelog View changes
quit Exit the program

🚫 Banning System

  • Stored in bannedusers.txt

When a user is banned:

  • Their account is removed
  • Their mailbox is deleted
  • Their username cannot be reused

🔮 Planned Features

  • Improved security (salted hashing, validation)
  • Better error handling
  • Cleaner code structure
  • Database support (SQLite)
  • Logging system
  • Admin tools / interface

🤝 Contributing

  • 🐛 Found a bug? Open an issue
  • 💡 Have an idea? Suggest a feature
  • 🔧 Want to improve the code? Submit a PR

All contributions are welcome.


🤖 AI declaration

Used copilot for deployment to PyPi and chatgpt for simple bug fixes early on and for writing part of the ReadMe


📄 License

This project is free to use for educational purposes.


Made with learning in mind.
If you like it, consider ⭐ starring the repo!

I will try to update this program once in a while so I have a changelog aswel.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

simple_login_system-0.1.5.tar.gz (44.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

simple_login_system-0.1.5-py3-none-any.whl (31.9 kB view details)

Uploaded Python 3

File details

Details for the file simple_login_system-0.1.5.tar.gz.

File metadata

  • Download URL: simple_login_system-0.1.5.tar.gz
  • Upload date:
  • Size: 44.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.1

File hashes

Hashes for simple_login_system-0.1.5.tar.gz
Algorithm Hash digest
SHA256 55b1161c3edda35e64d4dc1f52cbd7e7b23b610d414d6c719c0e70630384d0a7
MD5 49881445dc393ee89bbc9a3300caa5b7
BLAKE2b-256 a9e6ea56a5e3ec6e7160348a42a92e4ed78b1686a3021f34b594be574ac3bf48

See more details on using hashes here.

File details

Details for the file simple_login_system-0.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for simple_login_system-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 8ace60dde0af53d0a4a89f90990cb69ae380b3a5e65d636d285a151f2098e88b
MD5 0b62105af8be73c137fce4d5d5e1fd6b
BLAKE2b-256 11521e951db4cba801f313f9eaf55524d25f1872df4e57b8f5adf39ff09645a8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page