Update CHANGELOG, README and comments

Since more than Mastodon and Pleroma are supported now, this has
to be reflected in the documentation accordingly.

Author: oe4dns

CHANGELOG.md

@@ -5,7 +5,25 @@ Change Log
 ----------
 
 There is talk that Mastodon might get Group support, so maybe this tool will be obsolete in the not too distant future. We'll see
-about that. tootgroup.py will be supported as long as there is a need for it.
+about that. tootgroup.py will be supported as long as there is a need for it - For Mastodon and/or other Fediverse services.
+
+[1.5] 2024-10-12
+----------------
+
+### ADDED
+
+- Compatibility with GoToSocial (tested) and possibly other Fediverse services (untested).
+- OAuth support for registering the tootgroup.py application with servers (needed for GoToSocial but also works with other
+   services)
+
+### CHANGED
+
+- There are no more retries while registering the application with username/password. Instead an OAuth fallback is invoked.
+  If this also fails, you have to retry manually.
+
+### FIXED
+
+- [GoToSocial](<https://github.com/oe4dns/tootgroup.py/issues/10>)
 
 [1.4.3] 2023-12-18
 ----------------

README.md

@@ -1,25 +1,33 @@
 
-`tootgroup.py` - emulate group accounts on Mastodon and Pleroma
+`tootgroup.py` - Group accounts on Fediverse services that don't support them natively.
 =================================================
 
+Tested to be compatible with:
+------------
+
+``Hosting groups:`` Mastodon, Pleroma and GoToSocial - others will probably work too.
+
+``Posting to groups:`` Mastodon, Pleroma GoToSocial and Friendica - others will
+                       very likely work.
+
 What is this?
 -------------
 
-Some social media platforms allow groups of users to post into a unified "group"
-timeline/instance/whatever you want to call it. This is currently not possible
-on Mastodon or Pleroma without giving all members full login credentials to a
-group. `tootgroup.py` is an attempt to solve this specific use case.
+Some federated social media platforms allow groups of users to post into a
+unified "group" timeline/instance/whatever you want to call it. This is currently
+not possible on Mastodon or other services that are styled after it, except by
+giving all members full login credentials to a group. `tootgroup.py` is an
+attempt to solve this specific use case.
 
-tootgroup.py groups can be hosted on Mastodon or Pleroma. But you can post
-TO the group FROM any ActivityPub service although there might be some
-incompatibilities. Currently Mastodon, Pleroma and Friendica are tested platforms
-for posting TO the group. More tests are welcome!
+`tootgroup.py` groups can be hosted on a variety of services that are compatible
+with the Mastodon API. All tested platforms are listed above, more will very
+likely work just as good and all tests are welcome!
 
 How does it work?
 -----------------
 
 `tootgroup.py` has to be set up on a computer and run periodically. It reads the
-notifications from the Mastodon/Pleroma account it is connected to and filters
+notifications from the Fediverse account it is connected to and filters
 them for messages to repost. The group consists of all user accounts the group
 account is following. Unfollowing accounts, removes users from the group again.
 
@@ -43,7 +51,7 @@ anything.
 But how to simply use it?
 -------------------------
 
-### Mastodon/Pleroma
+### Mastodon/Pleroma/GoToSocial and others
 
 1. Write a message that should be boosted by the group:
    Just include "!@group_name" anywhere in the toot.
@@ -65,8 +73,8 @@ this is fully supported, tested and in daily use.
    Friendica handles the Exclamation Mark in a special way because it is also
    used to address the Friendica Forum functionality. Therefore the Asterisk is
    used instead of the Exclamation Mark. Just include "*@group_name" anywhere in
-   the message. - This would also work in Mastodon/Pleroma, just don't tell them
-   ;-)
+   the message. - This would also work with other services like Mastodon, just
+   don't tell them ;-)
 
    EXAMPLE (from Friendica): "OHAI! just found that *@mastodon thingie!"
 
@@ -99,13 +107,13 @@ when you run it from the commandline for the first time. Being somewhat
 comfortable with Python scripting and the commandline in general might help
 if difficulties should appear.
 
-1. You need an account on any Mastodon or Pleroma instance that will act as
+1. You need an account on any Fediverse instance that will act as
    your group account. Think about if you should mark it as a "Bot".
 
 2. Run `tootgroup.py` from the command line.
 
 3. `tootgroup.py` will ask you for all needed setup data and try to get them
-   right by connecting to the Mastodon/Pleroma server. If it cannot do so, it
+   right by connecting to the Fediverse server. If it cannot do so, it
    will tell you and you can retry. When successful, `tootgroup.py` will write
    the configuration to its tootgroup.conf file and read it from there next
    time you run the script.

pyproject.toml

@@ -11,9 +11,9 @@ dependencies = [
 ]
 requires-python = ">=3.8"
 authors = [ {name = "Andreas Schreiner", email = "andreas.schreiner@sonnenmulde.at"} ]
-description="Group account features on Mastodon, Pleroma and Friendica"
+description="Group account features on Mastodon and many other Fediverse platforms "
 readme="README.md"
-keywords=["mastodon", "pleroma", "friendica", "toot", "group", "account", "fediverse"]
+keywords=["mastodon", "pleroma", "friendica", "gotosocial", "toot", "group", "account", "fediverse"]
 classifiers=[
     "Environment :: Console",
     "Development Status :: 5 - Production/Stable",

tootgroup.py

@@ -23,7 +23,7 @@
 
 import tootgroup_tools
 
-TOOTGROUP_VERSION = "1.4.3"
+TOOTGROUP_VERSION = "1.5"
 
 
 def main():
@@ -40,7 +40,7 @@ def main():
     # Get the configuration storage location
     config_store = tootgroup_tools.configuration_management.setup_configuration_store()
 
-    # Get the Mastodon/Pleroma account handle the script is running for.
+    # Get the handle for the account the script has been invoked with.
     config_store["group_name"] = commandline_arguments["group_name"]
     group_name = config_store["group_name"]
 
@@ -65,8 +65,8 @@ def main():
 
     try:
         # Get the group account information.
-        # This connects to the Mastodon or Pleroma server for the first time at
-        # every tootgroup.py's run.
+        # This connects to the Fediverse server for the first time at
+        # every tootgroup.py's invocation.
         my_account = {
             "username": masto.account_verify_credentials().username,
             "id": masto.account_verify_credentials().id,
@@ -75,7 +75,7 @@ def main():
     except Exception as ex:
         print("")
         print("\n########################################################")
-        print("tootgroup.py could not connect to the Mastodon or Pleroma")
+        print("tootgroup.py could not connect to the Fediverse server")
         print("instance. If you know that it is running, there might be a")
         print("problem with your local configuration. Check the error")
         print("message for more details:")
@@ -86,7 +86,7 @@ def main():
         sys.exit(0)
 
     # Get group member IDs. They can not be fetched directly when
-    # connecting to the Mastodon server.
+    # connecting to the Fediverse server.
     #
     # limit=sys.maxsize is set here because Pleroma only returns 20 Member if
     # the standard limit=None value is used!
@@ -305,8 +305,8 @@ def media_toot_again(orig_media_dict, mastodon_instance):
     videos) in a new toot. This function downloads all media files from a toot
     and re-uploads them. It then returns a dict formatted in a proper way to
     be used by the Mastodon.status_post() function.
-    It also works with Pleroma this way altough it has not been tested if there
-    would be another, more "direct" solution with that software."""
+    It also works with Pleroma and others this way, altough it has not been tested
+    if there would be another, more "direct" solution with alternative services."""
     new_media_dict = []
     for media in orig_media_dict:
         media_data = requests.get(media.url).content

tootgroup_tools/commandline_arguments.py

@@ -47,11 +47,11 @@ def parse_arguments():
         "-g",
         "--group",
         default="default",
-        help="Input a handle for the Mastodon account. tootgroup.py stores all "
+        help="Input a handle for the Fediverse account. tootgroup.py stores all "
         + "information connected to a specific group account under this name. "
         + "By choosing different handles it is possible to manage multiple "
-        + "Mastodon groups from the same skript. This can be chosen freely but "
-        + " it is wise to use a name that is related to the Mastodon account "
+        + "groups from the same skript. The handle can be chosen freely but "
+        + " it is wise to use a name that is related to the Fediverse account "
         + " it will be used with. If no handle is given, "
         + '"%(default)s" is always used instead.',
     )

tootgroup_tools/configuration_management.py

@@ -11,7 +11,7 @@
 
 
 def new_credentials_from_server(config_store, config):
-    """Register tootgroup.py at a Mastodon (or Pleroma) server and get
+    """Register tootgroup.py at a compatible Fediverse server and get
     user credentials.
 
     "config_store" dictionary containting config file name and path as
@@ -25,7 +25,7 @@ def new_credentials_from_server(config_store, config):
     """
     group_name = config_store["group_name"]
 
-    # Register tootgroup.py app at the Mastodon server
+    # Register tootgroup.py app at the Fediverse server
     try:
         mastodon.Mastodon.create_app(
             "tootgroup.py",
@@ -42,7 +42,7 @@ def new_credentials_from_server(config_store, config):
     except Exception as ex:
         print("")
         print("\n##################################################################")
-        print("The Mastodon instance URL is wrong or the server does not respond.")
+        print("The Fediverse instance URL is wrong or the server does not respond.")
         print("See the error message for more details:")
         print(ex)
         print("")
@@ -51,12 +51,12 @@ def new_credentials_from_server(config_store, config):
         sys.exit(0)
 
     # Try to log in once with username and password to get an access token for future logins.
-    # This might fail due to wrong user entry of because username/password login is not
+    # This might fail due to wrong user entry or because username/password login is not
     # supported. In any case, if an error occurs, try logging in via OAuth instead. Only
-    # if this also fails, exit the script with an error message asking the user to try again.
+    # when this also fails, exit the script with an error message telling the user to try again.
     try:
         masto.log_in(
-            input("Username (e-Mail) to log into Mastodon Instance: "),
+            input("Username (e-Mail) to log into the Fediverse Instance: "),
             input("Password: "),
             scopes=["read", "write"],
             redirect_uri="urn:ietf:wg:oauth:2.0:oob",
@@ -73,7 +73,7 @@ def new_credentials_from_server(config_store, config):
             scopes=["read", "write"],
         )
 
-        print("\nPlease open the following URL in your webbrowser, authorize")
+        print("\nPlease open the following URL in your webbrowser, then authorize")
         print("this application's access and copy the resulting access token")
         print("to the prompt below.\n")
         print("Authorization URL:")
@@ -128,15 +128,15 @@ def parse_configuration(config_store):
         config_store["write_NEW"] = True
         config_store["first_run"] = True
 
-    # Do we have a mastodon instance URL? If not, we have to
+    # Do we have a Fediverse instance URL? If not, we have to
     # ask for it and register with our group's server first.
     if not config.has_option(group_name, "mastodon_instance"):
         config[group_name]["mastodon_instance"] = ""
-        print("We need a Mastodon server to connect to!")
+        print("We need a Fediverse server to connect to!")
     if config[group_name]["mastodon_instance"] == "":
         config[group_name]["mastodon_instance"] = input(
             "Enter the "
-            "URL of the Mastodon instance your group account is "
+            "URL of the Fediverse instance your group account is "
             "running on: "
         )
         get_new_credentials = True
@@ -220,7 +220,7 @@ def parse_configuration(config_store):
         config_store["write_NEW"] = True
 
     # Some registration info or credentials were missing - we have to register
-    # tootgroup.py with our Mastodon server instance. (again?)
+    # tootgroup.py with our Fediverse server instance. (again?)
     if get_new_credentials:
         print("Some credentials are missing, need to get new ones...")
         new_credentials_from_server(config_store, config)