anyrun-tg-bot


Nameanyrun-tg-bot JSON
Version 0.6.4 PyPI version JSON
download
home_pageNone
SummaryA Telegram bot for interacting with the ANY.RUN API
upload_time2024-10-14 18:15:56
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseMIT License
keywords anyrun any.run telegram bot api malware analysis security sandbox threat intelligence cybersecurity
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # ANY.RUN for Telegram

This Telegram bot provides a user-friendly interface to interact with the ANY.RUN API. It allows users to submit files and URLs for analysis, retrieve analysis results, and perform various operations with the ANY.RUN service directly through Telegram.

## Key Features

- Submit files and URLs for analysis in ANY.RUN Sandbox
- Retrieve analysis results and reports
- Check the status of ongoing analyses
- Manage API keys within the Telegram interface
- Automatic language detection and support
- Flexible logging system with adjustable log levels
- Asynchronous database operations for improved performance
- Secure database backup with password protection
- Admin panel for user management and system operations

## Getting Started

Follow these instructions to set up and run the bot.

### Installation

1. **Clone the repository**:
   ```bash
   git clone https://github.com/bykovk-pro/ANY.RUN-for-Telegram.git
   cd ANY.RUN-for-Telegram
   ```

2. **Create a virtual environment (recommended)**:
   ```bash
   python -m venv venv
   source venv/bin/activate  # On Windows use `venv\Scripts\activate`
   ```

3. **Install the bot**:
   ```bash
   pip install .
   ```

### Configuration

1. **Set up the environment variables**:

   Create a `.env` file in the project root with the following content:

   ```plaintext
   TELEGRAM_TOKEN=<your_telegram_token>
   TELEGRAM_ADMIN_ID=<your_telegram_admin_id>
   REQUIRED_GROUP_IDS=<comma_separated_group_ids>
   LOG_LEVEL=<your_log_level>
   TELEGRAM_LOG_LEVEL=<your_telegram_log_level>
   SQLITE_LOG_LEVEL=<your_sqlite_log_level>
   DB_PASSWORD=<your_backup_password>
   ```

   Replace the placeholder values with your actual values.

### Running the Bot

To run the bot, use the following command:

```bash
anyrun-tg-bot start
```

The bot will start and run in the foreground. For production use, consider using a process manager to run the bot as a background service.

## License

This project is licensed under the MIT License - see the LICENSE file for details.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "anyrun-tg-bot",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "anyrun, any.run, telegram, bot, api, malware, analysis, security, sandbox, threat intelligence, cybersecurity",
    "author": null,
    "author_email": "Kirill Bykov <me@bykovk.pro>",
    "download_url": "https://files.pythonhosted.org/packages/20/7c/6e2cc47c3bff4e484f99dabe450a81e85d59f73aad437bb5577adb62c1d9/anyrun_tg_bot-0.6.4.tar.gz",
    "platform": null,
    "description": "# ANY.RUN for Telegram\n\nThis Telegram bot provides a user-friendly interface to interact with the ANY.RUN API. It allows users to submit files and URLs for analysis, retrieve analysis results, and perform various operations with the ANY.RUN service directly through Telegram.\n\n## Key Features\n\n- Submit files and URLs for analysis in ANY.RUN Sandbox\n- Retrieve analysis results and reports\n- Check the status of ongoing analyses\n- Manage API keys within the Telegram interface\n- Automatic language detection and support\n- Flexible logging system with adjustable log levels\n- Asynchronous database operations for improved performance\n- Secure database backup with password protection\n- Admin panel for user management and system operations\n\n## Getting Started\n\nFollow these instructions to set up and run the bot.\n\n### Installation\n\n1. **Clone the repository**:\n   ```bash\n   git clone https://github.com/bykovk-pro/ANY.RUN-for-Telegram.git\n   cd ANY.RUN-for-Telegram\n   ```\n\n2. **Create a virtual environment (recommended)**:\n   ```bash\n   python -m venv venv\n   source venv/bin/activate  # On Windows use `venv\\Scripts\\activate`\n   ```\n\n3. **Install the bot**:\n   ```bash\n   pip install .\n   ```\n\n### Configuration\n\n1. **Set up the environment variables**:\n\n   Create a `.env` file in the project root with the following content:\n\n   ```plaintext\n   TELEGRAM_TOKEN=<your_telegram_token>\n   TELEGRAM_ADMIN_ID=<your_telegram_admin_id>\n   REQUIRED_GROUP_IDS=<comma_separated_group_ids>\n   LOG_LEVEL=<your_log_level>\n   TELEGRAM_LOG_LEVEL=<your_telegram_log_level>\n   SQLITE_LOG_LEVEL=<your_sqlite_log_level>\n   DB_PASSWORD=<your_backup_password>\n   ```\n\n   Replace the placeholder values with your actual values.\n\n### Running the Bot\n\nTo run the bot, use the following command:\n\n```bash\nanyrun-tg-bot start\n```\n\nThe bot will start and run in the foreground. For production use, consider using a process manager to run the bot as a background service.\n\n## License\n\nThis project is licensed under the MIT License - see the LICENSE file for details.\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "A Telegram bot for interacting with the ANY.RUN API",
    "version": "0.6.4",
    "project_urls": {
        "Homepage": "https://any.run",
        "Repository": "https://github.com/bykovk-pro/ANY.RUN-for-Telegram"
    },
    "split_keywords": [
        "anyrun",
        " any.run",
        " telegram",
        " bot",
        " api",
        " malware",
        " analysis",
        " security",
        " sandbox",
        " threat intelligence",
        " cybersecurity"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "06f6f5047df1062d91b91a29f19c7de5689789d3fba5741ed062bd6f7d28bc04",
                "md5": "fdc52a53d6a8c9949fe5d55eb6213e63",
                "sha256": "6c76b57cdd3056357ef10ffbb34d362eb94a3459f7658f8816cc9dbcff7b1e4c"
            },
            "downloads": -1,
            "filename": "anyrun_tg_bot-0.6.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "fdc52a53d6a8c9949fe5d55eb6213e63",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 35240,
            "upload_time": "2024-10-14T18:15:54",
            "upload_time_iso_8601": "2024-10-14T18:15:54.598404Z",
            "url": "https://files.pythonhosted.org/packages/06/f6/f5047df1062d91b91a29f19c7de5689789d3fba5741ed062bd6f7d28bc04/anyrun_tg_bot-0.6.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "207c6e2cc47c3bff4e484f99dabe450a81e85d59f73aad437bb5577adb62c1d9",
                "md5": "7aed5a7db0c2ccaca19cc2518c8afb1a",
                "sha256": "98c0408ef935d97e35a0ba74b773660374a485f4418106ec146b471540300499"
            },
            "downloads": -1,
            "filename": "anyrun_tg_bot-0.6.4.tar.gz",
            "has_sig": false,
            "md5_digest": "7aed5a7db0c2ccaca19cc2518c8afb1a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 24387,
            "upload_time": "2024-10-14T18:15:56",
            "upload_time_iso_8601": "2024-10-14T18:15:56.537127Z",
            "url": "https://files.pythonhosted.org/packages/20/7c/6e2cc47c3bff4e484f99dabe450a81e85d59f73aad437bb5577adb62c1d9/anyrun_tg_bot-0.6.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-14 18:15:56",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "bykovk-pro",
    "github_project": "ANY.RUN-for-Telegram",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "anyrun-tg-bot"
}
        
Elapsed time: 0.45873s