Steal My Neko🐈

Installation • Changelog • Contributing

About

Awesome Telegram parser & poster configured to steal nekos.
Script uses web and telegram parsers. Telegram parser requires user account to receive and use files directly. Telegram parser supports ad block which automatically detects ad links and mentions.

Started in June 2021

Installation

1. Clone repository:
   git clone https://github.com/unxho/steal-my-neko && cd steal-my-neko

2. Install requirements:
   pip install -r requirements.txt

   You can additionaly install optional-requirements.txt which will make the script faster, but also may cause os-related bugs.

   Using poetry

   poetry install
   With optional requirements:
   poetry install -E speedups -E ui

3. Rename example config:
   mv {example.,}config.ini
   And fill it in.

4. Start the script:
   python -m smn

   Using poetry

   poetry run python -m smn

Debugging avalible using --debug flag.

Adding custom sources

All sources are in smn/parser/__init__.py.
Private telegram sources must be configured using channel_id keyword argument to avoid losing channel entity.
Web parsers requires postprocessing. Define your processors at smn/parser/_processors.py.

Contributing

Please read before contributing.

Tools

Formatter: black
Linter: pylint

Always test your changes.

Do not submit something without at least running the module.

Do not make large changes before discussing them first.

We want to know what exactly you are going to make to give you an advice and make sure you are not wasting your time on it.

Do not make formatting PRs.

We know that our code might be not clean enough, but we don't want to merge, view or get notified about 1-line PR which fixes trailing whitelines. Please don't waste everyone's time with pointless changes.