This bot is used for one and only task - post pictures from my personal archive.
This repository has been archived on 2024-08-21. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file
Profitroll 0b0ca6b832 revert 7f786d59ca
revert Update dependency aiohttp to ~=3.10.0 (#84)

This PR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [aiohttp](https://github.com/aio-libs/aiohttp) | minor | `~=3.9.1` -> `~=3.10.0` |

---

### Release Notes

<details>
<summary>aio-libs/aiohttp (aiohttp)</summary>

### [`v3.10.0`](https://github.com/aio-libs/aiohttp/blob/HEAD/CHANGES.rst#3100-2024-07-30)

[Compare Source](https://github.com/aio-libs/aiohttp/compare/v3.9.5...v3.10.0)

\========================

## Bug fixes

-   Fixed server response headers for `Content-Type` and `Content-Encoding` for
    static compressed files -- by :user:`steverep`.

    Server will now respond with a `Content-Type` appropriate for the compressed
    file (e.g. `"application/gzip"`), and omit the `Content-Encoding` header.
    Users should expect that most clients will no longer decompress such responses
    by default.

    *Related issues and pull requests on GitHub:*
    :issue:`4462`.

-   Fixed duplicate cookie expiration calls in the CookieJar implementation

    *Related issues and pull requests on GitHub:*
    :issue:`7784`.

-   Adjusted `FileResponse` to check file existence and access when preparing the response -- by :user:`steverep`.

    The :py:class:`~aiohttp.web.FileResponse` class was modified to respond with
    403 Forbidden or 404 Not Found as appropriate.  Previously, it would cause a
    server error if the path did not exist or could not be accessed.  Checks for
    existence, non-regular files, and permissions were expected to be done in the
    route handler.  For static routes, this now permits a compressed file to exist
    without its uncompressed variant and still be served.  In addition, this
    changes the response status for files without read permission to 403, and for
    non-regular files from 404 to 403 for consistency.

    *Related issues and pull requests on GitHub:*
    :issue:`8182`.

-   Fixed `AsyncResolver` to match `ThreadedResolver` behavior
    \-- by :user:`bdraco`.

    On system with IPv6 support, the :py:class:`~aiohttp.resolver.AsyncResolver` would not fallback
    to providing A records when AAAA records were not available.
    Additionally, unlike the :py:class:`~aiohttp.resolver.ThreadedResolver`, the :py:class:`~aiohttp.resolver.AsyncResolver`
    did not handle link-local addresses correctly.

    This change makes the behavior consistent with the :py:class:`~aiohttp.resolver.ThreadedResolver`.

    *Related issues and pull requests on GitHub:*
    :issue:`8270`.

-   Fixed `ws_connect` not respecting `receive_timeout`` on WS(S) connection. -- by :user:`arcivanov\`.

    *Related issues and pull requests on GitHub:*
    :issue:`8444`.

-   Removed blocking I/O in the event loop for static resources and refactored
    exception handling -- by :user:`steverep`.

    File system calls when handling requests for static routes were moved to a
    separate thread to potentially improve performance. Exception handling
    was tightened in order to only return 403 Forbidden or 404 Not Found responses
    for expected scenarios; 500 Internal Server Error would be returned for any
    unknown errors.

    *Related issues and pull requests on GitHub:*
    :issue:`8507`.

## Features

-   Added a Request.wait_for_disconnection() method, as means of allowing request handlers to be notified of premature client disconnections.

    *Related issues and pull requests on GitHub:*
    :issue:`2492`.

-   Added 5 new exceptions: :py:exc:`~aiohttp.InvalidUrlClientError`, :py:exc:`~aiohttp.RedirectClientError`,
    :py:exc:`~aiohttp.NonHttpUrlClientError`, :py:exc:`~aiohttp.InvalidUrlRedirectClientError`,
    :py:exc:`~aiohttp.NonHttpUrlRedirectClientError`

    :py:exc:`~aiohttp.InvalidUrlRedirectClientError`, :py:exc:`~aiohttp.NonHttpUrlRedirectClientError`
    are raised instead of :py:exc:`ValueError` or :py:exc:`~aiohttp.InvalidURL` when the redirect URL is invalid. Classes
    :py:exc:`~aiohttp.InvalidUrlClientError`, :py:exc:`~aiohttp.RedirectClientError`,
    :py:exc:`~aiohttp.NonHttpUrlClientError` are base for them.

    The :py:exc:`~aiohttp.InvalidURL` now exposes a `description` property with the text explanation of the error details.

    \-- by :user:`setla`, :user:`AraHaan`, and :user:`bdraco`

    *Related issues and pull requests on GitHub:*
    :issue:`2507`, :issue:`3315`, :issue:`6722`, :issue:`8481`, :issue:`8482`.

-   Added a feature to retry closed connections automatically for idempotent methods. -- by :user:`Dreamsorcerer`

    *Related issues and pull requests on GitHub:*
    :issue:`7297`.

-   Implemented filter_cookies() with domain-matching and path-matching on the keys, instead of testing every single cookie.
    This may break existing cookies that have been saved with `CookieJar.save()`. Cookies can be migrated with this script::

        import pickle
        with file_path.open("rb") as f:
            cookies = pickle.load(f)

        morsels = [(name, m) for c in cookies.values() for name, m in c.items()]
        cookies.clear()
        for name, m in morsels:
            cookies[(m["domain"], m["path"].rstrip("/"))][name] = m

        with file_path.open("wb") as f:
            pickle.dump(cookies, f, pickle.HIGHEST_PROTOCOL)

    *Related issues and pull requests on GitHub:*
    :issue:`7583`, :issue:`8535`.

-   Separated connection and socket timeout errors, from ServerTimeoutError.

    *Related issues and pull requests on GitHub:*
    :issue:`7801`.

-   Implemented happy eyeballs

    *Related issues and pull requests on GitHub:*
    :issue:`7954`.

-   Added server capability to check for static files with Brotli compression via a `.br` extension -- by :user:`steverep`.

    *Related issues and pull requests on GitHub:*
    :issue:`8062`.

## Removals and backward incompatible breaking changes

-   The shutdown logic in 3.9 waited on all tasks, which caused issues with some libraries.
    In 3.10 we've changed this logic to only wait on request handlers. This means that it's
    important for developers to correctly handle the lifecycle of background tasks using a
    library such as `aiojobs`. If an application is using `handler_cancellation=True` then
    it is also a good idea to ensure that any :func:`asyncio.shield` calls are replaced with
    :func:`aiojobs.aiohttp.shield`.

    Please read the updated documentation on these points: \
    https://docs.aiohttp.org/en/stable/web_advanced.html#graceful-shutdown \
    https://docs.aiohttp.org/en/stable/web_advanced.html#web-handler-cancellation

    \-- by :user:`Dreamsorcerer`

    *Related issues and pull requests on GitHub:*
    :issue:`8495`.

## Improved documentation

-   Added documentation for `aiohttp.web.FileResponse`.

    *Related issues and pull requests on GitHub:*
    :issue:`3958`.

-   Improved the docs for the `ssl` params.

    *Related issues and pull requests on GitHub:*
    :issue:`8403`.

## Contributor-facing changes

-   Enabled HTTP parser tests originally intended for 3.9.2 release -- by :user:`pajod`.

    *Related issues and pull requests on GitHub:*
    :issue:`8088`.

## Miscellaneous internal changes

-   Improved URL handler resolution time by indexing resources in the UrlDispatcher.
    For applications with a large number of handlers, this should increase performance significantly.
    \-- by :user:`bdraco`

    *Related issues and pull requests on GitHub:*
    :issue:`7829`.

-   Added `nacl_middleware <https://github.com/CosmicDNA/nacl_middleware>`\_ to the list of middlewares in the third party section of the documentation.

    *Related issues and pull requests on GitHub:*
    :issue:`8346`.

-   Minor improvements to static typing -- by :user:`Dreamsorcerer`.

    *Related issues and pull requests on GitHub:*
    :issue:`8364`.

-   Added a 3.11-specific overloads to `ClientSession`  -- by :user:`max-muoto`.

    *Related issues and pull requests on GitHub:*
    :issue:`8463`.

-   Simplified path checks for `UrlDispatcher.add_static()` method -- by :user:`steverep`.

    *Related issues and pull requests on GitHub:*
    :issue:`8491`.

-   Avoided creating a future on every websocket receive -- by :user:`bdraco`.

    *Related issues and pull requests on GitHub:*
    :issue:`8498`.

-   Updated identity checks for all `WSMsgType` type compares -- by :user:`bdraco`.

    *Related issues and pull requests on GitHub:*
    :issue:`8501`.

-   When using Python 3.12 or later, the writer is no longer scheduled on the event loop if it can finish synchronously. Avoiding event loop scheduling reduces latency and improves performance. -- by :user:`bdraco`.

    *Related issues and pull requests on GitHub:*
    :issue:`8510`.

-   Restored :py:class:`~aiohttp.resolver.AsyncResolver` to be the default resolver. -- by :user:`bdraco`.

    :py:class:`~aiohttp.resolver.AsyncResolver` was disabled by default because
    of IPv6 compatibility issues. These issues have been resolved and
    :py:class:`~aiohttp.resolver.AsyncResolver` is again now the default resolver.

    *Related issues and pull requests on GitHub:*
    :issue:`8522`.

***

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNi4zNS4wIiwidXBkYXRlZEluVmVyIjoiMzYuMzUuMCIsInRhcmdldEJyYW5jaCI6ImRldiJ9-->

Reviewed-on: #84
Co-authored-by: Renovate <renovate@git.end-play.xyz>
Co-committed-by: Renovate <renovate@git.end-play.xyz>
2024-08-01 00:44:21 +03:00
classes Fixed caption being added explicitly 2024-04-30 20:57:51 +02:00
docs Updates wiki init 2023-03-22 11:02:13 +01:00
locale Fixed deletion not working properly 2024-05-06 12:47:09 +02:00
modules Update dependency photosapi_client to v0.6.0 (#75) 2024-03-19 23:25:03 +02:00
plugins Fixed deletion not working properly 2024-05-06 12:47:09 +02:00
.gitignore Update dependency photosapi_client to v0.6.0 (#75) 2024-03-19 23:25:03 +02:00
.renovaterc Fixed branch name in Renovate config 2023-04-20 13:35:52 +02:00
config_example.json Attempt to work around #40 2023-08-16 13:20:25 +02:00
LICENSE Initial commit 2022-08-08 14:53:26 +02:00
loop.bat Starting scripts and README were updated 2023-06-28 08:22:18 +02:00
loop.sh Starting scripts and README were updated 2023-06-28 08:22:18 +02:00
main.py CLI is back and updated 2023-07-03 11:27:15 +02:00
README_uk.md Updated README 2023-07-03 12:34:55 +02:00
README.md Updated README 2023-07-03 12:34:55 +02:00
requirements.txt revert 7f786d59ca 2024-08-01 00:44:21 +03:00
start.bat Starting scripts and README were updated 2023-06-28 08:22:18 +02:00
start.sh Starting scripts and README were updated 2023-06-28 08:22:18 +02:00

TelegramPoster

License: GPL Code style: black

Шукаєш інструкцію українською? А вона ось тут знаходиться)

This bot is used for one and only task - post pictures from my personal archive. Here's its source code so you can also host a bot and have fun with it. Just don't exepect it to be brilliant. It is not. But hey, you can always fork it ;)

Dependencies

Use MongoDB's installation manual and Photos API's README.

Please note that Photos API also requires MongoDB so it makes sense to install and configure Mongo first.

Installation

To make this bot run at first you need to have a Python interpreter, Photos API, MongoDB and optionally git (if you want to update using git pull). You can also ignore git and simply download source code, should also work fine. After that you're ready to go.

In this README I assume that you're using default python in your system and your system's PATH contains it. If your default python is python3 or for example /home/user/.local/bin/python3.9 - use it instead. If it's non-standard executable path - you should also change it in scripts you will use (loop.sh, loop.bat, start.sh and start.bat).

  1. Install MongoDB and Photos API:

    1. Install MongoDB by following official installation manual
    2. Install Photos API by following Photos API's README
  2. Download the bot:

    1. git clone -b dev https://git.end-play.xyz/profitroll/TelegramPoster.git (if you're using git)
    2. cd TelegramPoster
  3. Create virtual environment [Optional]:

    1. Install virtualenv module: pip install virtualenv
    2. Create venv: python -m venv .venv
    3. Activate it using source .venv/bin/activate on Linux, .venv\Scripts\activate.bat in CMD or .venv\Scripts\Activate.ps1 in PowerShell.
  4. Install project's dependencies:

    python -m pip install -r requirements.txt
    Without installing those - bot cannot work at all.

  5. Configure required keys with your favorite text editor:

    1. Copy config file: cp config_example.json config.json
    2. Open config.json using your favorite text editor. For example nano config.json, but you can also edit it with vim, mcedit, or Notepad/Notepad++ on Windows
    3. Change "bot.owner", "bot.api_id", "bot.api_hash" and "bot.bot_token" keys' values.

    If you don't know where to find bot_token and your id - here you can find some hints: get bot token, get your id, get api_hash and api_id.

  6. Configure database and API:

    1. Configure database:

      1. Change database host and port in keys "database.host" and "database.port". For default local installation those will be 127.0.0.1 and 27017 respectively
      2. Change database name to the one you like in "database.name". It will be automatically created on start
      3. If you've changed user and password to access the db, you should also change "database.user" and "database.password" keys, otherwise leave them null (default).
    2. Configure Photos API:

      1. Change "posting.api.address" and "posting.api.address_external" to the ones your API server uses
      2. Run your bot using python main.py --create-user --create-album to configure its new user and album. You can also use manual user and album creation described in the wiki. You can also change username, password and album in"posting.api" to the user and album you have if you already have Photos API album and user set up. In that case you don't need to create a new one.
  7. Add bot to the channel:

    To use your bot of course you need to have a channel or group otherwise it makes no sense to have such a bot. Here you can find a quick guide how to add your bot to a channel. After that simply set "posting.channel" to your channel's ID and "posting.comments" to comments group's ID.

  8. Configure posting time:

    To make your bot post random content you need to configure "posting.time" with a list of "DD:MM" formatted strings or use "posting.interval" formatted as "XdXhXmXs". To use interval instead of selected time, set "posting.use_interval" to true.

  9. Good to go, run it!

    Make sure MongoDB and Photos API are running and use python main.py to start the bot.
    Or you can also use .\start.bat on Windows and bash ./start.sh on Linux.
    Additionally there are loop.sh and loop.bat available if you want your bot to start again after being stopped or after using /shutdown command.

If you need any further instructions on how to configure your bot or you had any difficulties doing so - please use wiki in this repository to get more detailed instructions.

CLI arguments

Of course bot also has them. You can perform some actions with them.

  • --create-user - create new API user. Requires config key "posting.api.address" to be set;
  • --create-album - create new API album. Requires API address and user config ("posting.api") to be complete.

Examples:

  • python main.py --create-user
  • python main.py --create-user --create-album

Tips and improvements

  • You may want to configure your bot to work as a systemd service instead. There's a tutorial for that in the wiki.

Localization

Bot is capable of using custom locales. There are some that are pre-installed (English and Ukrainian), however you can add your own locales too.

All localization files are located in the locale. Just copy locale file of your choice, name it in accordance to IETF language tags (if you want your locale to be compatible with Telegram's locales) or define your own name. Save it as json and you're good to go. If you want to change default locale for messages - edit "locale" parameter in the config.json.

We recommend to only make changes to your custom locale. Or at least always have your backup of for example en.json as your fallback.