gupsup


Namegupsup JSON
Version 1.0.2 PyPI version JSON
download
home_pagehttps://github.com/iamRahul21/terminalchat
SummarySecure terminal-based chat application for real-time communication
upload_time2025-08-13 10:45:41
maintainerNone
docs_urlNone
authorRahul Deka
requires_python>=3.8
licenseNone
keywords chat terminal websocket real-time
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <div align="center">

# gupsup

<em>A secure terminal-based chat application for real-time communication — right from your terminal.</em>

[![PyPI Downloads](https://static.pepy.tech/badge/gupsup)](https://pepy.tech/projects/gupsup)
[![PyPI version](https://img.shields.io/pypi/v/gupsup)](https://pypi.org/project/gupsup/)
[![Python version](https://img.shields.io/pypi/pyversions/gupsup)](https://pypi.org/project/gupsup/)

Learn more and explore detailed info at [gupsup-cli](https://gupsup-cli.vercel.app/)
</div>



## ⚡ Quick Start

```bash
pip install gupsup
gupsup
```

[![PyPI](https://img.shields.io/pypi/v/gupsup?label=Install%20from%20PyPI)](https://pypi.org/project/gupsup/)

That's it! Start chatting instantly.

## Features

- **Zero-friction setup** - Just run `gupsup` and start chatting
- **Secure channels** - Create private rooms with shareable codes  
- **Auto-reconnection** - Handles network issues gracefully
- **Cross-platform** - Works on Windows, macOS, Linux
- **No account required** - Anonymous secure communication

## Usage

```bash
# Install once
pip install gupsup

# Run anywhere
gupsup
```

### Example Session
```
gupsup - Secure Communication Channel
Channel code (or 'new' to create): new
Channel created: a4b2c1
Share code 'a4b2c1' with others to join
Username: qwerty

Establishing connection...
🟢 Connected to channel: a4b2c1
Commands: Type messages to send, 'quit' to exit

qwerty: Hello world!
mrrobot: Hey there!
qwerty: quit
Terminating session.
```

## How It Works

1. **Create or join** a secure channel with a 6-character code
2. **Share the code** with people you want to chat with
3. **Chat securely** - messages are only sent to your channel
4. **No persistence** - messages disappear when you disconnect

## Security & Privacy

- **Channel isolation** - Only people with your code can join
- **No message storage** - Everything is real-time only
- **No accounts** - Completely anonymous
- **Secure transport** - All communication encrypted in transit

## Development Install
```bash
git clone https://github.com/iamRahul21/terminalchat.git
cd terminalchat
pip install -e .
gupsup
```

## Commands

- **Type normally** to send messages
- **`quit`** or **`exit`** to leave
- **Ctrl+C** to force quit
- **Enter without text** is ignored

## Troubleshooting

**Connection timeouts?**
- First connection may be slow (server waking up)
- Try again - should connect immediately
- Check internet connection

**Messages not appearing?**
- Ensure same channel code
- Check if others are actually connected
- Try creating a new channel

## 📦 Package Details

- **Package**: `gupsup` on PyPI
- **Command**: `gupsup` 
- **Python**: 3.8+ required
- **Dependencies**: Only `websockets>=11.0`
- **Size**: Ultra-lightweight

## Architecture

```
Terminal Client ←→ WebSocket ←→ FastAPI Server ←→ Channel Manager
    (gupsup)                   (gupsup-server)
```

## Contributing

1. Fork on GitHub
2. Create feature branch
3. Test thoroughly  
4. Submit pull request

## 📄 License

MIT License - use freely, contribute back.

## Author

**[Rahul Deka](https://rahul-deka.vercel.app/)**

---

**Simple. Secure. Terminal-native.**

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/iamRahul21/terminalchat",
    "name": "gupsup",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "chat, terminal, websocket, real-time",
    "author": "Rahul Deka",
    "author_email": "Rahul Deka <rahuldeka072@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/44/1d/3fc24d5780bacc19377130f195edadd66f6cb975dd9ce1736f58d9b92b6b/gupsup-1.0.2.tar.gz",
    "platform": null,
    "description": "<div align=\"center\">\r\n\r\n# gupsup\r\n\r\n<em>A secure terminal-based chat application for real-time communication \u2014 right from your terminal.</em>\r\n\r\n[![PyPI Downloads](https://static.pepy.tech/badge/gupsup)](https://pepy.tech/projects/gupsup)\r\n[![PyPI version](https://img.shields.io/pypi/v/gupsup)](https://pypi.org/project/gupsup/)\r\n[![Python version](https://img.shields.io/pypi/pyversions/gupsup)](https://pypi.org/project/gupsup/)\r\n\r\nLearn more and explore detailed info at [gupsup-cli](https://gupsup-cli.vercel.app/)\r\n</div>\r\n\r\n\r\n\r\n## \u26a1 Quick Start\r\n\r\n```bash\r\npip install gupsup\r\ngupsup\r\n```\r\n\r\n[![PyPI](https://img.shields.io/pypi/v/gupsup?label=Install%20from%20PyPI)](https://pypi.org/project/gupsup/)\r\n\r\nThat's it! Start chatting instantly.\r\n\r\n## Features\r\n\r\n- **Zero-friction setup** - Just run `gupsup` and start chatting\r\n- **Secure channels** - Create private rooms with shareable codes  \r\n- **Auto-reconnection** - Handles network issues gracefully\r\n- **Cross-platform** - Works on Windows, macOS, Linux\r\n- **No account required** - Anonymous secure communication\r\n\r\n## Usage\r\n\r\n```bash\r\n# Install once\r\npip install gupsup\r\n\r\n# Run anywhere\r\ngupsup\r\n```\r\n\r\n### Example Session\r\n```\r\ngupsup - Secure Communication Channel\r\nChannel code (or 'new' to create): new\r\nChannel created: a4b2c1\r\nShare code 'a4b2c1' with others to join\r\nUsername: qwerty\r\n\r\nEstablishing connection...\r\n\ud83d\udfe2 Connected to channel: a4b2c1\r\nCommands: Type messages to send, 'quit' to exit\r\n\r\nqwerty: Hello world!\r\nmrrobot: Hey there!\r\nqwerty: quit\r\nTerminating session.\r\n```\r\n\r\n## How It Works\r\n\r\n1. **Create or join** a secure channel with a 6-character code\r\n2. **Share the code** with people you want to chat with\r\n3. **Chat securely** - messages are only sent to your channel\r\n4. **No persistence** - messages disappear when you disconnect\r\n\r\n## Security & Privacy\r\n\r\n- **Channel isolation** - Only people with your code can join\r\n- **No message storage** - Everything is real-time only\r\n- **No accounts** - Completely anonymous\r\n- **Secure transport** - All communication encrypted in transit\r\n\r\n## Development Install\r\n```bash\r\ngit clone https://github.com/iamRahul21/terminalchat.git\r\ncd terminalchat\r\npip install -e .\r\ngupsup\r\n```\r\n\r\n## Commands\r\n\r\n- **Type normally** to send messages\r\n- **`quit`** or **`exit`** to leave\r\n- **Ctrl+C** to force quit\r\n- **Enter without text** is ignored\r\n\r\n## Troubleshooting\r\n\r\n**Connection timeouts?**\r\n- First connection may be slow (server waking up)\r\n- Try again - should connect immediately\r\n- Check internet connection\r\n\r\n**Messages not appearing?**\r\n- Ensure same channel code\r\n- Check if others are actually connected\r\n- Try creating a new channel\r\n\r\n## \ud83d\udce6 Package Details\r\n\r\n- **Package**: `gupsup` on PyPI\r\n- **Command**: `gupsup` \r\n- **Python**: 3.8+ required\r\n- **Dependencies**: Only `websockets>=11.0`\r\n- **Size**: Ultra-lightweight\r\n\r\n## Architecture\r\n\r\n```\r\nTerminal Client \u2190\u2192 WebSocket \u2190\u2192 FastAPI Server \u2190\u2192 Channel Manager\r\n    (gupsup)                   (gupsup-server)\r\n```\r\n\r\n## Contributing\r\n\r\n1. Fork on GitHub\r\n2. Create feature branch\r\n3. Test thoroughly  \r\n4. Submit pull request\r\n\r\n## \ud83d\udcc4 License\r\n\r\nMIT License - use freely, contribute back.\r\n\r\n## Author\r\n\r\n**[Rahul Deka](https://rahul-deka.vercel.app/)**\r\n\r\n---\r\n\r\n**Simple. Secure. Terminal-native.**\r\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Secure terminal-based chat application for real-time communication",
    "version": "1.0.2",
    "project_urls": {
        "Homepage": "https://github.com/iamRahul21/terminalchat",
        "Issues": "https://github.com/iamRahul21/terminalchat/issues",
        "Repository": "https://github.com/iamRahul21/terminalchat"
    },
    "split_keywords": [
        "chat",
        " terminal",
        " websocket",
        " real-time"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ab6193dd7f761c8c0ad87c4485400acc94109da86f084cde11c8d5dea8d379f4",
                "md5": "9cb5ef5625e93dd2e57dd6c4fe97cc9b",
                "sha256": "4f270fcd806da4142b529b0b8dc93b1671fe874e84ce9736c3b5e2450734d4c0"
            },
            "downloads": -1,
            "filename": "gupsup-1.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9cb5ef5625e93dd2e57dd6c4fe97cc9b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 6786,
            "upload_time": "2025-08-13T10:45:40",
            "upload_time_iso_8601": "2025-08-13T10:45:40.050383Z",
            "url": "https://files.pythonhosted.org/packages/ab/61/93dd7f761c8c0ad87c4485400acc94109da86f084cde11c8d5dea8d379f4/gupsup-1.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "441d3fc24d5780bacc19377130f195edadd66f6cb975dd9ce1736f58d9b92b6b",
                "md5": "352ef94555fc4e21cccdad3f8fec61b4",
                "sha256": "6a33b5bfd18a602bd4d17d409628f4f69c7d503c7f354addb546e670e360ecbb"
            },
            "downloads": -1,
            "filename": "gupsup-1.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "352ef94555fc4e21cccdad3f8fec61b4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 6185,
            "upload_time": "2025-08-13T10:45:41",
            "upload_time_iso_8601": "2025-08-13T10:45:41.263411Z",
            "url": "https://files.pythonhosted.org/packages/44/1d/3fc24d5780bacc19377130f195edadd66f6cb975dd9ce1736f58d9b92b6b/gupsup-1.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-13 10:45:41",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "iamRahul21",
    "github_project": "terminalchat",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "gupsup"
}
        
Elapsed time: 1.45354s