Metadata-Version: 2.4
Name: ntb-67-client
Version: 0.1.4
Summary: Asyncio Tunneling Proxy Client — alternative for ngrok/localtunnel
Author-email: "Timur Zolotov (netbiom)" <helloworldbooo@gmail.com>
License: NTB-67 Source-Available Commercial License
Project-URL: Homepage, https://github.com/TZbooo/ntb-67
Project-URL: Telegram Support, https://t.me/netbiom
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# ntb-67 — Asyncio Tunneling Proxy Client

[![PyPI
version](https://img.shields.io/pypi/v/ntb-67-client.svg)](https://pypi.org/project/ntb-67-client/)
[![License](https://img.shields.io/badge/License-Source--Available-orange.svg)](LICENSE)
[![Telegram
Support](https://img.shields.io/badge/Telegram-Support-blue.svg?logo=telegram)](https://t.me/netbiom)

------------------------------------------------------------------------

ntb-67-client — это легковесный асинхронный CLI-клиент на базе Python
asyncio, предназначенный для быстрого проброса локальных портов в
глобальную сеть. Альтернатива таким инструментам, как ngrok и
localtunnel.

> Проект в стадии разработки (WIP): Архитектура находится в состоянии
> активного тестирования. Стабильность версий не гарантируется, а
> документация будет дополняться по мере стабилизации API.

### Особенности

-   Полная асинхронность: Высокая производительность и низкое
    потребление ресурсов благодаря asyncio.
-   Динамические поддомены: Автоматическое выделение уникальных адресов
    на сервере маршрутизации.
-   Автоматическое возобновление: Устойчивость к кратковременным сбоям
    сети и сохранение сессии подключения.

### Требования

-   Python \>= 3.10
-   Перед использованием необходимо открыть Telegram-бота
    **@Hwlajbdjxbot** и через меню получить свой **api_key** (код
    доступа).

### Быстрый старт

#### 1. Получение API-ключа

1.  Откройте Telegram-бота **@Hwlajbdjxbot**.
2.  Получите свой **api_key** через меню бота.

#### 2. Установка

Установите пакет напрямую из PyPI:

``` bash
pip install ntb-67-client
```

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

Запустите туннель, указав порт локального веб-сервера (например, 8000) и
ваш api_key:

``` bash
ntb-67-client 8000 <your_api_key>
```

После успешного подключения вы получите URL вида
`https://<subdomain>.24tunl.ru`
