Merge branch 'main' into settings_page

src/auto_archiver/core/base_module.py

@@ -50,7 +50,6 @@ class BaseModule(ABC):
 
     def config_setup(self, config: dict):
 
-        authentication = config.get('authentication', {})
         # this is important. Each instance is given its own deepcopied config, so modules cannot
         # change values to affect other modules
         config = deepcopy(config)
@@ -106,8 +105,8 @@ class BaseModule(ABC):
             for key in self.authentication.keys():
                 if key in site or site in key:
                     logger.debug(f"Could not find exact authentication information for site '{site}'. \
-                                    did find information for '{key}' which is close, is this what you meant? \
-                                    If so, edit your authentication settings to make sure it exactly matches.")
+did find information for '{key}' which is close, is this what you meant? \
+If so, edit your authentication settings to make sure it exactly matches.")
 
         def get_ytdlp_cookiejar(args):
             import yt_dlp
@@ -117,7 +116,7 @@ class BaseModule(ABC):
             # collections.namedtuple('ParsedOptions', ('parser', 'options', 'urls', 'ydl_opts'))
             ytdlp_opts = getattr(parse_options(args), 'ydl_opts')
             return yt_dlp.YoutubeDL(ytdlp_opts).cookiejar
-        
+
         get_cookiejar_options = None
 
         # order of priority:

src/auto_archiver/core/consts.py

@@ -14,7 +14,7 @@ DEFAULT_MANIFEST = {
     'name': '', # the display name of the module
     'author': 'Bellingcat', # creator of the module, leave this as Bellingcat or set your own name!
     'type': [], # the type of the module, can be one or more of MODULE_TYPES
-    'requires_setup': True, # whether or not this module requires additional setup such as setting API Keys or installing additional softare
+    'requires_setup': True, # whether or not this module requires additional setup such as setting API Keys or installing additional software
     'description': '', # a description of the module
     'dependencies': {}, # external dependencies, e.g. python packages or binaries, in dictionary format
     'entry_point': '', # the entry point for the module, in the format 'module_name::ClassName'. This can be left blank to use the default entry point of module_name::ModuleName

src/auto_archiver/core/orchestrator.py

@@ -15,6 +15,7 @@ from copy import copy
 
 from rich_argparse import RichHelpFormatter
 from loguru import logger
+import requests
 
 from .metadata import Metadata, Media
 from auto_archiver.version import __version__
@@ -335,7 +336,23 @@ Here's how that would look: \n\nsteps:\n  extractors:\n  - [your_extractor_name_
         yaml_config = self.load_config(basic_config.config_file)
 
         return self.setup_complete_parser(basic_config, yaml_config, unused_args)
+    
+    def check_for_updates(self):
+        response = requests.get("https://pypi.org/pypi/auto-archiver/json").json()
+        latest_version = response['info']['version']
+        # check version compared to current version
+        if latest_version != __version__:
+            if os.environ.get('RUNNING_IN_DOCKER'):
+                update_cmd = "`docker pull bellingcat/auto-archiver:latest`"
+            else:
+                update_cmd = "`pip install --upgrade auto-archiver`"
+            logger.warning("")
+            logger.warning("********* IMPORTANT: UPDATE AVAILABLE ********")
+            logger.warning(f"A new version of auto-archiver is available (v{latest_version}, you have {__version__})")
+            logger.warning(f"Make sure to update to the latest version using: {update_cmd}")
+            logger.warning("")
 
+        
     def setup(self, args: list):
         """
         Function to configure all setup of the orchestrator: setup configs and load modules.
@@ -343,6 +360,8 @@ Here's how that would look: \n\nsteps:\n  extractors:\n  - [your_extractor_name_
         This method should only ever be called once
         """
 
+        self.check_for_updates()
+
         if self.setup_finished:
             logger.warning("The `setup_config()` function should only ever be run once. \
                            If you need to re-run the setup, please re-instantiate a new instance of the orchestrator. \