Metadata-Version: 2.4
Name: nyxpy
Version: 0.2.0
Summary: Библиотека для взаимодействия с Nyx, бесплатного аналога Discord
Author-email: Nickolay Kushnarenko <kolya@nk.ax>
License: MIT License
        
        Copyright (c) 2025 Kolya
        
        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/kolya5544/nyxpy
Project-URL: Issues, https://github.com/kolya5544/nyxpy/issues
Keywords: nyx,websocket,httpx,bots,asyncio,discord
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: License :: OSI Approved :: MIT License
Classifier: Typing :: Typed
Classifier: Framework :: AsyncIO
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: httpx[http2]>=0.28.1
Requires-Dist: websockets>=15.0
Dynamic: license-file

# NyxPy
## _Библиотека для взаимодействия с Nyx, бесплатного аналога Discord_

NyxPy - это свободная и бесплатная библиотека для создания ботов для социальной сети и мессенджера Nyx. Nyx - бесплатный аналог Discord, который не боится блокировок.

NyxPy отличается...
- СКОРОСТЬЮ! Мы не используем перегруженные библиотеки и представляем лишь оболочку для взаимодействия с Nyx
- АСИНХРОННОСТЬЮ! Библиотека полностью асинхронная
- СТАБИЛЬНОСТЬЮ! На данный момент мы являемся самой обновляемой и проверенной библиотекой для разработки под Nyx.

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

Для начала вам необходимо создать экземпляр вашего клиента. Один клиент - один пользователь:
```python
from nyxpy import (
    NyxClient
)

nyx = NyxClient()
```

После этого необходимо авторизоваться:
```python
email = "ваша почта"
password = "ваш пароль"

await nyx.login(email, password)
```

Всё! Теперь вам доступны все функции. Например, вы можете подписаться на обновления в реальном времени:
```python
@nyx_event(type=nyx_event.NEW_MESSAGE) # новое сообщение
async def on_message(ev):
    if ev.data["sender_id"] == nyx.current_user.id: # игнорируем наши же сообщения
        return

    await nyx.reply(ev, f"Привет, {ev.data["member"]["username"]}!")

...

# подписываемся
await nyx.connect_ws()
await nyx.ws_subscribe_all()
```

Либо просто отправляем HTTP запросы:
```python
channels = await nyx.get_channels(server_id)
```

Больше примеров тут: https://github.com/kolya5544/NyxPy/tree/master/examples


## Функции

| Функция                | Статус  | Заметки |
|------------------------|---------|-------|
| Аутентификация         | ПОДДЕРЖИВАЕТСЯ | Используйте email + пароль для аутентификации в Nyx |
| Получение событий в реальном времени    | ПОДДЕРЖИВАЕТСЯ | Получайте новые сообщения, предложения дружбы и другие обновления в реальном времени |
| Отправка сообщений | Частично поддерживается | Отвечайте на сообщения, отправляйте свои сообщения. Загрузка файлов пока не поддерживается |
| Получение ролей, каналов, серверов, список предложений дружбы | ПОДДЕРЖИВАЕТСЯ | Можно получить полный список |
| Добавление в друзья | ПОДДЕРЖИВАЕТСЯ | Полностью поддерживается |
| Иные функции | Запланированы (делитесь идеями в issues -> https://github.com/kolya5544/NyxPy/issues) | Скоро всё будет |

## Технологии

NyxPy использует несколько библиотек для работы:

- websockets - для подключений по WebSocket
- httpx - для отправки HTTP запросов
- asyncio - для асинхронной работы

## Установка

NyxPy требует Python версии не ниже 3.11.

Установка производится командой:
```bash
pip install nyxpy
```

## Разработка

Хотите помочь с разработкой! Без проблем, оставьте ваш Pull Request. Качественные изменения в код будут приняты.

## Лицензия

MIT
