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
