Metadata-Version: 2.1
Name: herdcalls
Version: 0.0.2
Home-page: https://github.com/OnTheHerd/herdcalls
Author: OnTheHerd
Author-email: oth@pyroherd.org
License: LGPL-3.0
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: aiohttp>=3.9.3
Requires-Dist: ntgcalls>=1.1.2
Requires-Dist: psutil
Requires-Dist: screeninfo
Requires-Dist: deprecation
Requires-Dist: setuptools

<img src="https://raw.githubusercontent.com/herdcalls/herdcalls/master/.github/images/banner.png" alt="herdcalls logo" />
<p align="center">
    <b>A simple and elegant client that allows you to make group voice calls quickly and easily.</b>
    <br>
    <a href="https://github.com/herdcalls/herdcalls/tree/master/example">
        Examples
    </a>
    •
    <a href="https://herdcalls.github.io/">
        Documentation
    </a>
    •
    <a href="https://pypi.org/project/herdcalls/">
        PyPi
    </a>
    •
    <a href="https://t.me/herdcallsnews">
        Channel
    </a>
    •
    <a href="https://t.me/herdcallschat">
        Chat
    </a>
</p>

# HerdCalls [![PyPI](https://img.shields.io/pypi/v/herdcalls.svg?logo=python&logoColor=%23959DA5&label=pypi&labelColor=%23282f37)](https://pypi.org/project/herdcalls/) [![Downloads](https://pepy.tech/badge/herdcalls)](https://pepy.tech/project/herdcalls)
This project allows making Telegram group call using MtProto and WebRTC, this is possible thanks to the power of [NTgCalls] library and [@evgeny-nadymov]

#### Example Usage
```python
from herdcalls import HerdCalls
from herdcalls import idle
from herdcalls.types import MediaStream
...
chat_id = -1001185324811
app = HerdCalls(client)
app.start()
app.join_group_call(
    chat_id,
    MediaStream(
        'http://docs.evostream.com/sample_content/assets/sintel1m720p.mp4',
    )
)
idle()
```

## Features
- Prebuilt wheels for macOS, Linux and Windows.
- Supporting all type of MTProto libraries: Pyroherd, Telethon and Hydrogram.
- Work with voice chats in channels and chats.
- Join as channels or chats.
- Mute/unmute, pause/resume, stop/play, volume control and more...

## Requirements
- Python 3.7 or higher.
- An MTProto Client
- A [Telegram API key](https://docs.pyroherd.org/intro/setup#api-keys).

## How to install?
Here's how to install the HerdCalls lib, the commands are given below:

``` bash
# With Git
pip install git+https://github.com/herdcalls/herdcalls -U

# With PyPi (Recommended)
pip install herdcalls -U
```

## Key Contributors
* <b><a href="https://github.com/Laky-64">@Laky-64</a> (DevOps Engineer, Software Architect):</b>
    * Played a crucial role in developing HerdCalls being an ex developer of pyservercall and of tgcallsjs.
    * Automation with GitHub Actions
* <b><a href="https://github.com/kuogi">@kuogi</a> (Senior UI/UX designer, Documenter):</b>
    * As a Senior UI/UX Designer, Kuogi has significantly improved the user interface of our documentation,
      making it more visually appealing and user-friendly.
    * Played a key role in writing and structuring our documentation, ensuring that it is clear,
      informative, and accessible to all users.
* <b><a href="https://github.com/vrumger">@vrumger</a> (Senior Node.js Developer, Software Architect):</b>
    * Has made important fixes and enhancements to the WebRTC component of the library,
      improving its stability and performance.
    * Main developer of TgCallsJS
* <b><a href="https://github.com/alemidev">@alemidev</a> (Senior Python Developer):</b>
    * Has made important fixes and enhancements to the async part of the library

## Junior Developers
* <b><a href="https://github.com/TuriOG">@TuriOG</a> (Junior Python Developer):</b>
    * Currently working on integrating NTgCalls into <a href="//github.com/herdcalls/herdcalls">HerdCalls</a>, an important step
      in expanding the functionality and usability of the library.

## Special Thanks
* <b><a href="https://github.com/evgeny-nadymov">@evgeny-nadymov</a>:</b>
  A heartfelt thank you to Evgeny Nadymov for graciously allowing us to use their code from telegram-react.
  His contribution has been pivotal to the success of this project.

[NTgCalls]: https://github.com/herdcalls/ntgcalls
[@evgeny-nadymov]: https://github.com/evgeny-nadymov/
