From 248542d7a6767113a30085147b22551a81774546 Mon Sep 17 00:00:00 2001 From: Michael Thomas Date: Tue, 14 Mar 2023 10:23:05 +0000 Subject: [PATCH] add the stuff required to pull in followers, --- .github/workflows/get_context.yml | 2 +- README.md | 8 ++++++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/.github/workflows/get_context.yml b/.github/workflows/get_context.yml index 3cdc3eb..f92ce46 100644 --- a/.github/workflows/get_context.yml +++ b/.github/workflows/get_context.yml @@ -32,7 +32,7 @@ jobs: path: artifacts - name: Get Directory structure run: ls -lR - - run: python get_context.py ${{ secrets.ACCESS_TOKEN }} ${{ vars.MASTODON_SERVER }} ${{ vars.REPLY_INTERVAL_IN_HOURS }} ${{ vars.HOME_TIMELINE_LENGTH }} ${{ vars.MAX_FOLLOWINGS }} ${{ vars.USER }} + - run: python get_context.py ${{ secrets.ACCESS_TOKEN }} ${{ vars.MASTODON_SERVER }} ${{ vars.REPLY_INTERVAL_IN_HOURS }} ${{ vars.HOME_TIMELINE_LENGTH }} ${{ vars.MAX_FOLLOWINGS }} ${{ vars.USER }} ${{ vars.MAX_FOLLOWERS }} - name: Upload artifacts uses: actions/upload-artifact@v3 with: diff --git a/README.md b/README.md index bedaa00..f7fb005 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,12 @@ # Pull missing responses into Mastodon -This GitHub repository provides a GitHub action runs every 10 mins, and has two parts: +This GitHub repository provides a GitHub action that runs every 10 mins, doing the following: 1. It can [pull remote replies into your instance](https://blog.thms.uk/2023/03/pull-missing-responses-into-mastodon?utm_source=github), using the Mastodon API. That part itself has two parts: 1. It gets remote replies to posts that users on your instance have already replied to during the last `REPLY_INTERVAL_IN_HOURS` hours, and adds them to your own server. 2. It gets remote replies to the last `HOME_TIMELINE_LENGTH` posts from your home timeline, and adds them to your own server. 2. It can also [backfill posts](https://blog.thms.uk/2023/03/backfill-recently-followed-accounts?utm_source=github) from the last `MAX_FOLLOWINGS` users that you have followed. +3. In the same way, it can also backfill posts form the last `MAX_FOLLOWERS` users that have followed you. Each part can be disabled completely, and all of the values are configurable. @@ -46,6 +47,9 @@ For full context and discussion on why this is needed, read the following two bl 3. Required to backfill posts from your last followings (new in v3.0.0): - `MAX_FOLLOWINGS`: An integer number representing how many of your last followings you want to backfill. (e.g. `80`). Leave blank to disable this part of the script. - `USER`: The username of the user whose followings you want to pull in (e.g. `michael` for the user `@michael@thms.uk`). Leave blank to disable this part of the script. + 4. Required to backfill posts from your last followers (new in v3.0.1): + - `MAX_FOLLOWERS`: An integer number representing how many of your last followers you want to backfill. (e.g. `80`). Leave blank to disable this part of the script. + - `USER` (if not already provided): The username of the user whose followings you want to pull in (e.g. `michael` for the user `@michael@thms.uk`). Leave blank to disable this part of the script. 4. Finally go to the Actions tab and enable the action. The action should now automatically run approximately once every 10 min. ### 3) Runn this script locally as a cron job @@ -53,7 +57,7 @@ For full context and discussion on why this is needed, read the following two bl If you want to, you can of course also run this script locally as a cron job: 1. To get started, clone this repository. (If you'd rather not clone the full repository, you can simply download the `get_context.py` file, but don't forget to create a directory called `artifacts` in the same directory: The script expects this directory to be present, and stores information about posts it has already pushed into your instance in that directory, to avoid pushing the same posts over and over again.) -2. Then simply run this script like so: `python3 get_context.py ` (See the section above for an explanation of these parameters. The final two parameters can be omitted, if you are not interested.) +2. Then simply run this script like so: `python3 get_context.py ` (See the section above for an explanation of these parameters. The final two parameters can be omitted, if you are not interested.) When setting up your cronjob, do make sure you are setting the interval long enough that two runs of the script don't overlap though! Running this script with overlapping will have unpleasant results ...