Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kastaid/getter
Get and put users (scraping) to the target group/channel efficiently, correctly and safety.
https://github.com/kastaid/getter
bot bots group-management linux pluggable python python3 scraping scrapper telegram telegram-bot telegram-bots telegram-userbot telethon telethon-based telethon-userbot termux userbot userbot-telegram userbots
Last synced: 3 months ago
JSON representation
Get and put users (scraping) to the target group/channel efficiently, correctly and safety.
- Host: GitHub
- URL: https://github.com/kastaid/getter
- Owner: kastaid
- License: agpl-3.0
- Created: 2022-01-28T07:35:08.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-25T14:41:32.000Z (12 months ago)
- Last Synced: 2023-11-25T15:26:36.415Z (12 months ago)
- Topics: bot, bots, group-management, linux, pluggable, python, python3, scraping, scrapper, telegram, telegram-bot, telegram-bots, telegram-userbot, telethon, telethon-based, telethon-userbot, termux, userbot, userbot-telegram, userbots
- Language: Python
- Homepage: https://t.me/kastaid
- Size: 574 KB
- Stars: 28
- Watchers: 2
- Forks: 16
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# `getter`
> Get and put users (scraping) to the target **group/channel** efficiently, correctly and safety.
```
#include
/*
* Your Telegram account may get banned.
* We are not responsible for any improper use of this userbot.
* This userbot is specific for scraping members with some helpfull commands.
*
* If you ended up spamming groups, getting reported left and right,
* and you ended up in being fight with Telegram
* and at the end Telegram Team deleted your account. DON'T BLAME US.
*
* No personal support will be provided / We won't spoon feed you.
* If you need help ask in our support group
* and we or our friends will try to help you.
*/
```
## Table of Contents
Details
- [Requirements](#requirements)
- [STRING_SESSION](#string_session)
- [Deploy](#deploy)
- [Locally](#locally)
- [Config](#config)
- [Run](#run)
- [Example Plugin](#example-plugin)
- [Supports](#sparkling_heart-supports)
- [Credits and Thanks](#credits-and-thanks)
- [Contributing](#contributing)
- [License](#license)
## Requirements
- Python 3.11.x
- Linux (Recommend Debian/Ubuntu)
- Telegram `API_ID` and `API_HASH` from [API development tools](https://my.telegram.org)
### STRING_SESSION
Generate `STRING_SESSION` using [@strgen_bot](https://telegram.me/strgen_bot) or [replit](https://replit.com/@notudope/strgen) or run locally `python3 strgen.py`
### Deploy
To deploy please visit our channel at [@kastaid](https://telegram.me/kastaid).
### Locally
#### Config
Create and save `config.env` file at main directory and fill with the example config file at [sample_config.env](https://github.com/kastaid/getter/blob/main/sample_config.env).
#### Run
```sh
# Production
pip3 install -r requirements.txt
python3 -m getter
# Development
pip3 install -r requirements.txt
pip3 install -r requirements-dev.txt
python3 -m run --watch
```
More commands `python3 -m run -h`
### Example Plugin
Clone the repo, then create and save plugin at `./getter/plugins/plugin_name.py`.
This Example Works Everywhere. (e.g. Groups, Personal Chats)
```python
from . import kasta_cmd
@kasta_cmd(pattern="hi")
async def _(event):
await event.eor("Hello **World**.")
```
This Example Works Only In Personal Chats.
```python
from . import kasta_cmd
@kasta_cmd(pattern="hi", func=lambda e: e.is_private)
async def _(event):
await event.eor("Hello **World**.")
```
This Example Works Only In Channels.
```python
from . import kasta_cmd
@kasta_cmd(pattern="hi", func=lambda e: e.is_channel and e.chat.broadcast)
async def _(event):
await event.eor("Hello **World**.")
```
This Example Works Only In Groups.
```python
from . import kasta_cmd
@kasta_cmd(pattern="hi", func=lambda e: e.is_group)
async def _(event):
await event.eor("Hello **World**.")
```
This Example Works Only In Groups or Channels.
```python
from . import kasta_cmd
@kasta_cmd(pattern="hi", func=lambda e: not e.is_private)
async def _(event):
await event.eor("Hello **World**.")
```
## :sparkling_heart: Supports
This project is open source and free to use under the [license](#license). However, if you are using this project and happy with it or just want to encourage me to continue creating stuff please donate!
## Credits and Thanks
* [LonamiWebs](https://github.com/LonamiWebs/Telethon) - Telethon
* [MarshalX](https://github.com/MarshalX/tgcalls) - pytgcalls
* [TeamUltroid](https://github.com/TeamUltroid) - Team Ultroid
* [UsergeTeam](https://github.com/UsergeTeam) - UsergeTeam
* [Dragon-Userbot](https://github.com/Dragon-Userbot) - Dragon Userbot
* [TgCatUB](https://github.com/TgCatUB) - CatUserbot
* [userbotindo](https://github.com/userbotindo) - Userbot Indonesia Community
* [illvart](https://github.com/illvart) - Core Developer
* [notudope](https://github.com/notudope) - Core Developer
and [everyone](https://github.com/kastaid/getter/graphs/contributors) 🦄
## Contributing
If you would like to help out with some code, check the [details](https://github.com/kastaid/getter/blob/main/docs/CONTRIBUTING.md).
## License
This project is licensed under the **GNU Affero General Public License v3.0**. See the [LICENSE](https://github.com/kastaid/getter/blob/main/LICENSE) file for details.