Skip to main content

byteline

License Python

Консольный чат в текстовом формате (TCP/UDP) с поддержкой шифрования и автоматического проброса портов (UPnP).

✨ Возможности

  • 🗨️ TCP/UDP поддержка — выбор протокола при подключении
  • 🔒 XOR-шифрование — базовое шифрование сообщений с помощью ключа
  • 🌐 UPnP проброс портов — автоматическая настройка port forwarding
  • 💬 Консольный интерфейс — простой и удобный CLI
  • 🔄 Многопользовательский режим — поддержка нескольких клиентов
  • ⚡ Быстрый старт — минимальная конфигурация

🚀 Установка

Требования

  • Python >= 3.6
  • pip

Установка из PyPI

pip install byteline

Установка из исходников

git clone https://github.com/yourusername/byteline.git
cd byteline
pip install -r requirements.txt
pip install .

📖 Использование

Базовые команды

byteline [флаги]

Параметры командной строки

Флаг Описание По умолчанию
-s, --server Запустить в режиме сервера -
-c, --client Запустить в режиме клиента -
-H, --host Хост для подключения localhost
-p, --port Порт подключения 8000
-k, --key Ключ шифрования (XOR) -
-m, --mode Режим: 1-TCP, 2-UDP 1 (TCP)
--upnp Включить автоматический проброс портов -

💡 Примеры использования

1. Запуск сервера с UPnP

byteline -s --upnp

Сервер автоматически пробросит порт и покажет публичный IP для подключения.

2. Запуск сервера на определённом порту

byteline -s -p 8080 --upnp

3. Подключение к серверу по публичному IP

byteline -c -H 123.45.67.89 -p 8080

4. Локальный чат (сам себе собеседник)

byteline -s -c -k secret123

5. Чат с шифрованием

# Сервер
byteline -s -k mypassword --upnp

# Клиент
byteline -c -H public-ip -p 8000 -k mypassword

6. Использование UDP

# Сервер
byteline -s -m 2

# Клиент
byteline -c -H localhost -p 8000 -m 2

7. Выход из чата

Во время чата введите одну из команд:

  • /quit
  • /exit
  • exit
  • quit

⚙️ Зависимости

  • miniupnpc>=2.2.0 — для UPnP-проброса портов

Установка зависимостей:

pip install -r requirements.txt

📋 Структура проекта

byteline/
├── byteline.py      # Основной код приложения
├── setup.py         # Конфигурация setuptools
├── requirements.txt # Зависимости проекта
├── README.md        # Документация
└── LICENSE          # Лицензия MIT

🤝 Вклад в проект

Приветствуются pull requests и issues! Пожалуйста, создавайте issue перед началом работы над крупными изменениями.

📄 Лицензия

Этот проект распространяется под лицензией MIT.

MIT License

Copyright (c) 2026 Veltnik

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.

📧 Контакты

🙏 Благодарности

  • miniupnpc — за библиотеку UPnP

⭐ Если проект вам понравился, поставьте звезду на GitHub!

Metadata

Release files for byteline 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for byteline 0.1.1
File Size Uploaded
byteline-0.1.1.tar.gz 7.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for byteline 0.1.1
File Interpreter ABI Platform
byteline-0.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 16.6 kB

Release files / byteline-0.1.1.tar.gz

Download URL byteline-0.1.1.tar.gz
Size 7.9 kB
Tags Source
SHA-256 checksum
How to use checksums
ae87ef534eeb62b7baf117cd874482e72adbd88cfc122011c4b5d4c753a76287
BLAKE2b-256 checksum
How to use checksums
1c64e80beb6cbad4839e34671858238f1b6bac2931a73247fef8dae48f063828
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.7

Release files / byteline-0.1.1-py3-none-any.whl

Download URL byteline-0.1.1-py3-none-any.whl
Size 8.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3ec0c5900514b205fbc6f322b2d6ac7a4866a8a89ee2a72d85cd44f3b0857465
BLAKE2b-256 checksum
How to use checksums
68de982d8bb2656764cd85a0d719b2d920e5ae99e9e6cc06f4a4dd8f830a28a4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.7

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page