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

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.4.tar.gz (44.3 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.4-py3-none-any.whl (31.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: simple_login_system-0.1.4.tar.gz
  • Upload date:
  • Size: 44.3 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.4.tar.gz
Algorithm Hash digest
SHA256 a20d8aee20948c7bbf05ea220f606254e3583e1a4ad1459825fee954c2a0a5c8
MD5 7710c2214b1db9e599bed760543e6ff0
BLAKE2b-256 5dfceed43acb046327016a406e6f8f3d5780175b32d3a4c549754f660b2d8cad

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for simple_login_system-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 07a6ba112d3e357b9852b22bb290e20e14aba7409e20e14800078f832dbb55bf
MD5 1ea94c74399613c7f774599160674b03
BLAKE2b-256 c28ce6cd1dc27dbe1878d910689ac9338d1b85a411ba93253da6a01551a15021

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