shanter 1.0.0__tar.gz

shanter-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Shreyash Dongare
+
+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.

shanter-1.0.0/PKG-INFO

@@ -0,0 +1,225 @@
+Metadata-Version: 2.4
+Name: shanter
+Version: 1.0.0
+Summary: A cross-platform terminal-based real-time chat application built with Python.
+Author: Shreyash Dongare
+License: MIT License
+        
+        Copyright (c) 2026 Shreyash Dongare
+        
+        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.
+Project-URL: Homepage, https://github.com/shreyash9999/shanter
+Project-URL: Repository, https://github.com/shreyash9999/shanter
+Project-URL: Issues, https://github.com/shreyash9999/shanter/issues
+Keywords: chat,terminal,cli,messenger,tcp,socket,networking,python
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Communications :: Chat
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: bcrypt
+Dynamic: license-file
+
+# SHANTER
+
+<p align="center">
+  <strong>A cross-platform terminal-based real-time chat application built with Python.</strong>
+</p>
+
+SHANTER is a lightweight terminal chat application that enables users to communicate in real time over TCP. It provides a simple command-line interface for registering accounts, authenticating users, searching for other users, and exchanging messages across Windows, macOS, and Linux.
+
+---
+
+## ✨ Features
+
+- 🔐 Secure user registration with password hashing (`bcrypt`)
+- 👤 User authentication (login/logout)
+- 🔍 Search for registered users
+- 💬 Real-time one-to-one messaging
+- 🌍 Cross-platform support (Windows, macOS, Linux)
+- 🖥️ Interactive command-line interface
+- 📦 Installable as a Python package
+- ⚡ Lightweight TCP socket-based architecture
+
+---
+
+## 📁 Project Structure
+
+```text
+shanter/
+├── client/        # Client application
+├── common/        # Shared protocol and utilities
+├── server/        # Server implementation
+├── tests/         # Tests
+├── data/          # SQLite database
+├── pyproject.toml
+├── README.md
+└── LICENSE
+```
+
+---
+
+## 🚀 Installation
+
+Clone the repository:
+
+```bash
+git clone https://github.com/shreyash9999/shanter.git
+cd shanter
+```
+
+Create and activate a virtual environment:
+
+### macOS / Linux
+
+```bash
+python3 -m venv .venv
+source .venv/bin/activate
+```
+
+### Windows
+
+```powershell
+python -m venv .venv
+.venv\Scripts\activate
+```
+
+Install SHANTER:
+
+```bash
+pip install -e .
+```
+
+---
+
+## ▶️ Running SHANTER
+
+### Start the server
+
+```bash
+python3 -m server.main
+```
+
+### Start the client
+
+Open another terminal and run:
+
+```bash
+shanter
+```
+
+---
+
+## 💻 Available Commands
+
+Once SHANTER starts, you can use the following commands:
+
+| Command | Description |
+|---------|-------------|
+| `register` | Create a new account |
+| `login` | Log in to an existing account |
+| `search` | Search for registered users |
+| `chat` | Start a conversation with another user |
+| `whoami` | Display the currently logged-in user |
+| `logout` | Log out of the current session |
+| `help` | Show available commands |
+| `exit` | Exit SHANTER |
+
+---
+
+## 🏗️ Architecture
+
+```text
+          +----------------------+
+          |      Client CLI      |
+          +----------+-----------+
+                     |
+                     |
+              TCP Socket
+                     |
+                     |
+          +----------v-----------+
+          |    SHANTER Server    |
+          +----------+-----------+
+                     |
+             SQLite Database
+```
+
+---
+
+## 🛠️ Technologies Used
+
+- Python 3.11+
+- TCP Sockets
+- SQLite
+- bcrypt
+- Threading
+- JSON-based communication protocol
+
+---
+
+## 🗺️ Roadmap
+
+### Version 1.0
+
+- ✅ User Registration
+- ✅ User Login
+- ✅ User Search
+- ✅ Real-time One-to-One Messaging
+- ✅ Interactive CLI
+- ✅ Cross-platform Support
+
+### Planned for Future Releases
+
+- Group Chat
+- File Transfer
+- Online Presence
+- Message History
+- End-to-End Encryption
+- Rich Terminal User Interface
+- Notifications
+
+---
+
+## 🤝 Contributing
+
+Contributions, ideas, and bug reports are welcome.
+
+If you discover a bug or have a feature request, please open an issue or submit a pull request.
+
+---
+
+## 📄 License
+
+This project is licensed under the MIT License.
+
+See the `LICENSE` file for details.
+
+---
+
+## 👨‍💻 Author
+
+**Shreyash Dongare**
+
+GitHub: https://github.com/shreyash9999

shanter-1.0.0/README.md

@@ -0,0 +1,182 @@
+# SHANTER
+
+<p align="center">
+  <strong>A cross-platform terminal-based real-time chat application built with Python.</strong>
+</p>
+
+SHANTER is a lightweight terminal chat application that enables users to communicate in real time over TCP. It provides a simple command-line interface for registering accounts, authenticating users, searching for other users, and exchanging messages across Windows, macOS, and Linux.
+
+---
+
+## ✨ Features
+
+- 🔐 Secure user registration with password hashing (`bcrypt`)
+- 👤 User authentication (login/logout)
+- 🔍 Search for registered users
+- 💬 Real-time one-to-one messaging
+- 🌍 Cross-platform support (Windows, macOS, Linux)
+- 🖥️ Interactive command-line interface
+- 📦 Installable as a Python package
+- ⚡ Lightweight TCP socket-based architecture
+
+---
+
+## 📁 Project Structure
+
+```text
+shanter/
+├── client/        # Client application
+├── common/        # Shared protocol and utilities
+├── server/        # Server implementation
+├── tests/         # Tests
+├── data/          # SQLite database
+├── pyproject.toml
+├── README.md
+└── LICENSE
+```
+
+---
+
+## 🚀 Installation
+
+Clone the repository:
+
+```bash
+git clone https://github.com/shreyash9999/shanter.git
+cd shanter
+```
+
+Create and activate a virtual environment:
+
+### macOS / Linux
+
+```bash
+python3 -m venv .venv
+source .venv/bin/activate
+```
+
+### Windows
+
+```powershell
+python -m venv .venv
+.venv\Scripts\activate
+```
+
+Install SHANTER:
+
+```bash
+pip install -e .
+```
+
+---
+
+## ▶️ Running SHANTER
+
+### Start the server
+
+```bash
+python3 -m server.main
+```
+
+### Start the client
+
+Open another terminal and run:
+
+```bash
+shanter
+```
+
+---
+
+## 💻 Available Commands
+
+Once SHANTER starts, you can use the following commands:
+
+| Command | Description |
+|---------|-------------|
+| `register` | Create a new account |
+| `login` | Log in to an existing account |
+| `search` | Search for registered users |
+| `chat` | Start a conversation with another user |
+| `whoami` | Display the currently logged-in user |
+| `logout` | Log out of the current session |
+| `help` | Show available commands |
+| `exit` | Exit SHANTER |
+
+---
+
+## 🏗️ Architecture
+
+```text
+          +----------------------+
+          |      Client CLI      |
+          +----------+-----------+
+                     |
+                     |
+              TCP Socket
+                     |
+                     |
+          +----------v-----------+
+          |    SHANTER Server    |
+          +----------+-----------+
+                     |
+             SQLite Database
+```
+
+---
+
+## 🛠️ Technologies Used
+
+- Python 3.11+
+- TCP Sockets
+- SQLite
+- bcrypt
+- Threading
+- JSON-based communication protocol
+
+---
+
+## 🗺️ Roadmap
+
+### Version 1.0
+
+- ✅ User Registration
+- ✅ User Login
+- ✅ User Search
+- ✅ Real-time One-to-One Messaging
+- ✅ Interactive CLI
+- ✅ Cross-platform Support
+
+### Planned for Future Releases
+
+- Group Chat
+- File Transfer
+- Online Presence
+- Message History
+- End-to-End Encryption
+- Rich Terminal User Interface
+- Notifications
+
+---
+
+## 🤝 Contributing
+
+Contributions, ideas, and bug reports are welcome.
+
+If you discover a bug or have a feature request, please open an issue or submit a pull request.
+
+---
+
+## 📄 License
+
+This project is licensed under the MIT License.
+
+See the `LICENSE` file for details.
+
+---
+
+## 👨‍💻 Author
+
+**Shreyash Dongare**
+
+GitHub: https://github.com/shreyash9999

shanter-1.0.0/client/auth.py

@@ -0,0 +1,101 @@
+from common.protocol import PacketType
+from common.utils import send_packet
+
+
+def signup(client_socket, response_manager):
+    print("\n=== Sign Up ===")
+
+    username = input("Username: ").strip()
+    password = input("Password: ").strip()
+
+    packet = {
+        "type": PacketType.SIGNUP,
+        "payload": {
+            "username": username,
+            "password": password,
+        },
+    }
+
+    send_packet(client_socket, packet)
+
+    response = response_manager.wait()
+
+    print(f"\n{response['payload']['message']}\n")
+
+
+def login(client_socket, response_manager):
+    print("\n=== Login ===")
+
+    username = input("Username: ").strip()
+    password = input("Password: ").strip()
+
+    packet = {
+        "type": PacketType.LOGIN,
+        "payload": {
+            "username": username,
+            "password": password,
+        },
+    }
+
+    send_packet(client_socket, packet)
+
+    response = response_manager.wait()
+
+    print(f"\n{response['payload']['message']}\n")
+
+    if response.get("type") == PacketType.SUCCESS:
+        response["payload"]["username"] = username
+
+    return response
+
+
+def search_users(client_socket, response_manager, query=None):
+    print("\n=== Search Users ===")
+
+    if query is None:
+        query = input("Search: ").strip()
+
+    packet = {
+        "type": PacketType.SEARCH_USER,
+        "payload": {
+            "query": query,
+        },
+    }
+
+    send_packet(client_socket, packet)
+
+    response = response_manager.wait()
+
+    payload = response.get("payload", {})
+
+    print(f"\n{payload.get('message', '')}")
+
+    users = payload.get("users", [])
+
+    if users:
+        print("\nUsers:")
+        for user in users:
+            print(f"- {user}")
+    else:
+        print("No users found.")
+
+    print()
+
+    send_packet(client_socket, packet)
+
+    response = response_manager.wait()
+
+    payload = response.get("payload", {})
+
+    print(f"\n{payload.get('message', '')}")
+
+    users = payload.get("users", [])
+
+    if users:
+        print("\nUsers:")
+        for user in users:
+            print(f"- {user}")
+    else:
+        print("No users found.")
+
+    print()

shanter-1.0.0/client/chat.py

@@ -0,0 +1,33 @@
+from common.protocol import PacketType
+from common.utils import send_packet
+
+
+def chat(client_socket, response_manager, recipient=None):
+    print("\n=== Chat ===")
+
+    if recipient is None:
+        recipient = input("Recipient: ").strip()
+
+    while True:
+        message = input("You> ").strip()
+
+        if message.lower() in {"exit", "quit", "back"}:
+            print("Leaving chat...\n")
+            break
+
+        if not message:
+            continue
+
+        packet = {
+            "type": PacketType.MESSAGE,
+            "payload": {
+                "to": recipient,
+                "message": message,
+            },
+        }
+
+        send_packet(client_socket, packet)
+
+        response = response_manager.wait()
+
+        print(response["payload"]["message"])

shanter-1.0.0/client/cli.py

@@ -0,0 +1,14 @@
+from client.main import start_client
+
+
+def main():
+    print("=" * 40)
+    print("Welcome to SHANTER")
+    print('Type "help" for available commands.')
+    print("=" * 40)
+
+    start_client()
+
+
+if __name__ == "__main__":
+    main()

shanter-1.0.0/client/listener.py

@@ -0,0 +1,25 @@
+from common.protocol import PacketType
+from common.utils import receive_packet
+
+
+def start_listener(client_socket, response_manager):
+    while True:
+        packet = receive_packet(client_socket)
+
+        if packet is None:
+            print("\nDisconnected from server.")
+            break
+
+        packet_type = packet.get("type")
+        payload = packet.get("payload", {})
+
+        if packet_type == PacketType.MESSAGE:
+            sender = payload.get("from", "Unknown")
+            message = payload.get("message", "")
+
+            print("\n" + "=" * 40)
+            print(f"{sender}: {message}")
+            print("=" * 40)
+
+        else:
+            response_manager.put(packet)