redditadmin 0.0.6__tar.gz → 0.1.0__tar.gz

{redditadmin-0.0.6 → redditadmin-0.1.0}/.idea/inspectionProfiles/profiles_settings.xml

@@ -1,5 +1,6 @@
 <component name="InspectionProjectProfileManager">
   <settings>
+    <option name="PROJECT_PROFILE" value="Default" />
     <option name="USE_PROJECT_PROFILE" value="false" />
     <version value="1.0" />
   </settings>

{redditadmin-0.0.6 → redditadmin-0.1.0}/.idea/reddit-admin.iml

@@ -1,7 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <module type="PYTHON_MODULE" version="4">
   <component name="NewModuleRootManager">
-    <content url="file://$MODULE_DIR$" />
+    <content url="file://$MODULE_DIR$">
+      <excludeFolder url="file://$MODULE_DIR$/venv" />
+    </content>
     <orderEntry type="jdk" jdkName="Python 3.11 (reddit-admin)" jdkType="Python SDK" />
     <orderEntry type="sourceFolder" forTests="false" />
   </component>

{redditadmin-0.0.6 → redditadmin-0.1.0}/.idea/workspace.xml

@@ -4,7 +4,28 @@
     <option name="autoReloadType" value="SELECTIVE" />
   </component>
   <component name="ChangeListManager">
-    <list default="true" id="195f63d3-192c-4e64-8cd8-909be23b7f21" name="Changes" comment="" />
+    <list default="true" id="195f63d3-192c-4e64-8cd8-909be23b7f21" name="Changes" comment="">
+      <change beforePath="$PROJECT_DIR$/.idea/inspectionProfiles/profiles_settings.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/inspectionProfiles/profiles_settings.xml" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/.idea/reddit-admin.iml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/reddit-admin.iml" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/README.md" beforeDir="false" afterPath="$PROJECT_DIR$/README.md" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/redditadmin/core.py" beforeDir="false" afterPath="$PROJECT_DIR$/src/redditadmin/core.py" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/redditadmin/plugin/__init__.py" beforeDir="false" afterPath="$PROJECT_DIR$/src/redditadmin/plugin/__init__.py" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/redditadmin/plugin/asynchronouspluginsexecutor.py" beforeDir="false" afterPath="$PROJECT_DIR$/src/redditadmin/plugin/asynchronouspluginsexecutor.py" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/redditadmin/plugin/exceptions.py" beforeDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/redditadmin/plugin/plugin.py" beforeDir="false" afterPath="$PROJECT_DIR$/src/redditadmin/plugin/plugin.py" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/redditadmin/plugin/pluginsexecutor.py" beforeDir="false" afterPath="$PROJECT_DIR$/src/redditadmin/plugin/pluginsexecutor.py" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/redditadmin/plugin/redditinterfacefactory.py" beforeDir="false" afterPath="$PROJECT_DIR$/src/redditadmin/plugin/redditinterfacefactory.py" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/redditadmin/program/__init__.py" beforeDir="false" afterPath="$PROJECT_DIR$/src/redditadmin/program/__init__.py" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/redditadmin/program/program.py" beforeDir="false" afterPath="$PROJECT_DIR$/src/redditadmin/program/program.py" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/redditadmin/program/streamprocessingprogram.py" beforeDir="false" afterPath="$PROJECT_DIR$/src/redditadmin/program/streamprocessingprogram.py" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/redditadmin/utility/__init__.py" beforeDir="false" afterPath="$PROJECT_DIR$/src/redditadmin/utility/__init__.py" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/redditadmin/utility/botcredentials.py" beforeDir="false" afterPath="$PROJECT_DIR$/src/redditadmin/utility/botcredentials.py" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/redditadmin/utility/contributionsutility.py" beforeDir="false" afterPath="$PROJECT_DIR$/src/redditadmin/utility/contributions.py" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/redditadmin/utility/decorators.py" beforeDir="false" afterPath="$PROJECT_DIR$/src/redditadmin/utility/decorators.py" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/redditadmin/utility/exceptions.py" beforeDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/redditadmin/utility/redditinterface.py" beforeDir="false" afterPath="$PROJECT_DIR$/src/redditadmin/utility/redditinterface.py" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/redditadmin/utility/redditsubmission.py" beforeDir="false" afterPath="$PROJECT_DIR$/src/redditadmin/utility/redditsubmission.py" afterDir="false" />
+    </list>
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
     <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
@@ -20,6 +41,14 @@
   <component name="Git.Settings">
     <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
   </component>
+  <component name="GitSEFilterConfiguration">
+    <file-type-list>
+      <filtered-out-file-type name="LOCAL_BRANCH" />
+      <filtered-out-file-type name="REMOTE_BRANCH" />
+      <filtered-out-file-type name="TAG" />
+      <filtered-out-file-type name="COMMIT_BY_MESSAGE" />
+    </file-type-list>
+  </component>
   <component name="MarkdownSettingsMigration">
     <option name="stateVersion" value="1" />
   </component>
@@ -34,8 +63,8 @@
   <component name="PropertiesComponent">
     <property name="RunOnceActivity.OpenProjectViewOnStart" value="true" />
     <property name="RunOnceActivity.ShowReadmeOnStart" value="true" />
-    <property name="last_opened_file_path" value="$PROJECT_DIR$/../reddit-admin-configurator" />
-    <property name="settings.editor.selected.configurable" value="preferences.keymap" />
+    <property name="last_opened_file_path" value="$PROJECT_DIR$/src/redditadmin/utility/contributionsutility.py" />
+    <property name="settings.editor.selected.configurable" value="Errors" />
   </component>
   <component name="RecentsManager">
     <key name="MoveFile.RECENT_KEYS">

{redditadmin-0.0.6 → redditadmin-0.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: redditadmin
-Version: 0.0.6
+Version: 0.1.0
 Summary: Extensible Python administrative bot
 Project-URL: Homepage, https://github.com/Grod56/reddit-admin
 Project-URL: Issues, https://github.com/Grod56/reddit-admin/issues
@@ -130,17 +130,21 @@ Plugin:
 
 ```py
 class MyPlugin[Plugin[MyProgram]]
-    """The plugin for our program"""
 
-    def __init__():
-        super().__init__("myprogram")
 
-    def get_program(self, reddit_interface):
-        """Overriden from Plugin superclass"""
+"""The plugin for our program"""
 
-        praw_reddit = reddit_interface.get_praw_reddit
 
-        return MyProgram(praw_reddit)
+def __init__():
+    super().__init__("myprogram")
+
+
+def get_program(self, reddit_interface):
+    """Overriden from Plugin superclass"""
+
+    praw_reddit = reddit_interface.praw_reddit
+
+    return MyProgram(praw_reddit)
 ```
 
 Voila! We may now supply our plugin to the bot and run it just as we did before

{redditadmin-0.0.6 → redditadmin-0.1.0}/README.md

@@ -116,17 +116,21 @@ Plugin:
 
 ```py
 class MyPlugin[Plugin[MyProgram]]
-    """The plugin for our program"""
 
-    def __init__():
-        super().__init__("myprogram")
 
-    def get_program(self, reddit_interface):
-        """Overriden from Plugin superclass"""
+"""The plugin for our program"""
 
-        praw_reddit = reddit_interface.get_praw_reddit
 
-        return MyProgram(praw_reddit)
+def __init__():
+    super().__init__("myprogram")
+
+
+def get_program(self, reddit_interface):
+    """Overriden from Plugin superclass"""
+
+    praw_reddit = reddit_interface.praw_reddit
+
+    return MyProgram(praw_reddit)
 ```
 
 Voila! We may now supply our plugin to the bot and run it just as we did before

{redditadmin-0.0.6 → redditadmin-0.1.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "redditadmin"
-version = "0.0.6"
+version = "0.1.0"
 authors = [
   { name="Grod56", email="providenceuniversalstudios@gmail.com" },
 ]

{redditadmin-0.0.6 → redditadmin-0.1.0}/src/redditadmin/core.py

@@ -1,43 +1,36 @@
 import logging
 import os
 import signal
-import sys
 import time
-from abc import ABC, abstractmethod
+from abc import ABCMeta, abstractmethod
 from logging.handlers import TimedRotatingFileHandler
 from pathlib import Path
 from typing import List
 
-from .utility.botcredentials import BotCredentials
-from .utility.exceptions import BotInitializationError, InvalidBotCredentialsError
+from .utility.botcredentials import InvalidBotCredentialsError, BotCredentials,\
+    BotCredentialsImplementation
+from .utility.miscellaneous import BotInitializationError
 from .plugin.asynchronouspluginsexecutor import AsynchronousPluginsExecutor
-from .plugin.exceptions import PluginsExecutorInitializationError
 from .plugin.plugin import Plugin
-from .plugin.pluginsexecutor import PluginsExecutor
-from .plugin.redditinterfacefactory import RedditInterfaceFactory
+from .plugin.pluginsexecutor import PluginsExecutor, PluginsExecutorInitializationError
+from .plugin.redditinterfacefactory import RedditInterfaceFactory, DefaultRedditInterfaceFactory
 
 
-class RedditAdmin(ABC):
-    """Type encapsulating a RedditAdmin instance"""
-
-    def __init__(self, *args):
-        pass
+class RedditAdmin(metaclass=ABCMeta):
+    """Encapsulates RedditAdmin bot"""
 
     @abstractmethod
     def run(self, bot_credentials: BotCredentials, listen: bool = False):
         """Run the bot"""
-
-        raise NotImplementedError
+        ...
 
     @abstractmethod
-    def stop(self):
+    def stop(self, wait: bool):
         """Shutdown the bot"""
+        ...
 
-        raise NotImplementedError
 
-
-class RedditAdminImplementation(RedditAdmin):
-    """Reddit Admin Bot"""
+class _RedditAdminImplementation(RedditAdmin):
 
     __plugins: List[Plugin]
     __pluginsExecutor: PluginsExecutor
@@ -106,7 +99,7 @@ class RedditAdminImplementation(RedditAdmin):
         # Setting the default console logging level global variable
         self.__defaultConsoleLoggingLevel = console_handler.level
 
-    def ___get_new_bot_credentials(self) -> BotCredentials:
+    def __get_new_bot_credentials(self) -> BotCredentials:
         """Convenience method to retrieve bot credentials from user input"""
 
         try:
@@ -125,7 +118,7 @@ class RedditAdminImplementation(RedditAdmin):
                 # Resume console logging
                 self.__resume_console_logging()
 
-                return BotCredentials(
+                return BotCredentialsImplementation(
                     user_agent, client_id,
                     client_secret, username,
                     password
@@ -144,7 +137,7 @@ class RedditAdminImplementation(RedditAdmin):
         # instance from provided credentials
 
         try:
-            reddit_interface_factory = RedditInterfaceFactory(
+            reddit_interface_factory = DefaultRedditInterfaceFactory(
                 bot_credentials
             )
         # Handle if credential authentication fails
@@ -154,7 +147,7 @@ class RedditAdminImplementation(RedditAdmin):
                 "Please enter new valid credentials"
             )
             try:
-                new_bot_credentials = self.___get_new_bot_credentials()
+                new_bot_credentials = self.__get_new_bot_credentials()
                 reddit_interface_factory = self.__get_reddit_interface_factory(new_bot_credentials)
             except (KeyboardInterrupt, EOFError):
                 raise BotInitializationError(
@@ -206,6 +199,7 @@ class RedditAdminImplementation(RedditAdmin):
             self.__pluginsExecutor = self.__initialize_plugins_executor(
                 bot_credentials
             )
+            self.__mainLogger.info("Bot successfully initialized")
 
             # -------------------------------------------------------------------------------
 
@@ -213,13 +207,10 @@ class RedditAdminImplementation(RedditAdmin):
         except BotInitializationError as er:
             self.__mainLogger.critical(
                 "A fatal error occurred during the "
-                "bot's initialization. The application "
-                "will now exit. Error(s): " + str(er),
+                "bot's initialization. Error(s): " + str(er),
                 exc_info=True
             )
-            sys.exit(2)  # TODO: May need future cleaning up
-
-        self.__mainLogger.info("Bot successfully initialized")
+            raise er
 
     # -------------------------------------------------------------------------------
 
@@ -310,21 +301,7 @@ class RedditAdminImplementation(RedditAdmin):
                 "'{}' is not a valid bot command".format(command)
             )
 
-    @staticmethod
-    def __kill_bot():
-        """Forcefully shut down the bot"""
-
-        # Windows kill command
-        if (
-                sys.platform.startswith('win32') or
-                sys.platform.startswith('cygwin')
-        ):
-            os.kill(os.getpid(), signal.CTRL_BREAK_EVENT)
-
-        # Linux kill command
-        os.kill(os.getpid(), signal.SIGKILL)
-
-    def __shut_down_bot(self, wait=True, shutdown_exit_code=0):
+    def __shut_down_bot(self, wait=True):
         """Shut down the bot"""
 
         if wait:
@@ -342,30 +319,13 @@ class RedditAdminImplementation(RedditAdmin):
                     )
                 )
             )
-            try:
-                self.__pluginsExecutor.shut_down(True)
-                self.__mainLogger.info('Bot successfully shut down')
-                if shutdown_exit_code != 0:
-                    sys.exit(shutdown_exit_code)
-
-            # Handle keyboard interrupt midway through graceful shutdown
-            except KeyboardInterrupt:
-
-                self.__mainLogger.warning(
-                    'Graceful shutdown aborted.'
-                )
-                self.__pluginsExecutor.shut_down(False)
-                self.__mainLogger.info('Bot shut down')
-
-                # Killing the process (only way to essentially stop all threads)
-                self.__kill_bot()
+            self.__pluginsExecutor.shut_down(True)
+            self.__mainLogger.info('Bot successfully shut down')
 
         else:
             self.__pluginsExecutor.shut_down(False)
             self.__mainLogger.info('Bot shut down')
 
-            self.__kill_bot()
-
     def __is_bot_shut_down(self):
         """Check if bot is shutdown"""
 
@@ -389,7 +349,7 @@ class RedditAdminImplementation(RedditAdmin):
                 'a graceful shutdown is attempted or press '
                 'Ctrl+C to exit immediately'
             )
-            self.__shut_down_bot(True, 1)
+            self.__shut_down_bot(True)
 
         # Handle unknown exception while bot is running
         except BaseException as ex:
@@ -399,7 +359,7 @@ class RedditAdminImplementation(RedditAdmin):
                 "a graceful shutdown is attempted or press "
                 "Ctrl+C to exit immediately: " + str(ex.args), exc_info=True
             )
-            self.__shut_down_bot(True, 2)
+            self.__shut_down_bot(True)
 
     def run(self, bot_credentials: BotCredentials, listen: bool = False):
 
@@ -427,9 +387,9 @@ class RedditAdminImplementation(RedditAdmin):
             if not self.__is_bot_shut_down():
                 self.__shut_down_bot()
 
-    def stop(self):
+    def stop(self, wait: bool):
 
-        self.__shut_down_bot()
+        self.__shut_down_bot(wait=wait)
 
     # -------------------------------------------------------------------------------
 
@@ -437,4 +397,4 @@ class RedditAdminImplementation(RedditAdmin):
 def get_reddit_admin(plugins: List[Plugin]) -> RedditAdmin:
     """Get a Reddit Admin instance"""
 
-    return RedditAdminImplementation(plugins=plugins)
+    return _RedditAdminImplementation(plugins=plugins)

redditadmin-0.1.0/src/redditadmin/plugin/__init__.py

@@ -0,0 +1,5 @@
+from .plugin import Plugin as IPlugin, AbstractPlugin as Plugin, PluginInitializationError
+from .pluginsexecutor import PluginsExecutor as IPluginsExecutor, \
+    AbstractPluginsExecutor as PluginsExecutor, PluginsExecutorInitializationError
+from .redditinterfacefactory import RedditInterfaceFactory as IRedditInterfaceFactory,\
+    DefaultRedditInterfaceFactory as RedditInterfaceFactory

{redditadmin-0.0.6 → redditadmin-0.1.0}/src/redditadmin/plugin/asynchronouspluginsexecutor.py

@@ -3,22 +3,19 @@
 import concurrent.futures
 from concurrent.futures import ThreadPoolExecutor, Future
 from typing import Dict, List
-from .pluginsexecutor import PluginsExecutor
+from .pluginsexecutor import AbstractPluginsExecutor, PluginsExecutorInitializationError
 from .redditinterfacefactory import RedditInterfaceFactory
 from .plugin import Plugin
-from .exceptions import PluginsExecutorInitializationError
 
 
-class AsynchronousPluginsExecutor(PluginsExecutor):
+class AsynchronousPluginsExecutor(AbstractPluginsExecutor):
     """
-    Class responsible for asynchronously executing
-    multiple plugins in different threads
+    Executes multiple plugins in different threads
     """
 
     __executor: ThreadPoolExecutor
     __plugins: Dict[str, Plugin]
     __executedPrograms: Dict[str, Future]
-    __redditInterfaceFactory: RedditInterfaceFactory
 
     def __init__(
             self,
@@ -182,7 +179,6 @@ class AsynchronousPluginsExecutor(PluginsExecutor):
             )
 
     def get_program_statuses(self):
-        """Get the executed program statuses"""
 
         program_statuses = \
             {
@@ -192,7 +188,6 @@ class AsynchronousPluginsExecutor(PluginsExecutor):
         return program_statuses
 
     def shut_down(self, wait):
-        """Shut down the plugin executor"""
 
         super().shut_down()
         for plugin in self.__plugins.values():

{redditadmin-0.0.6 → redditadmin-0.1.0}/src/redditadmin/plugin/plugin.py

@@ -1,20 +1,42 @@
 import logging
-from abc import ABC, abstractmethod
+from abc import ABCMeta, abstractmethod
 from typing import TypeVar, Generic
 
 from ..program.program import Program
 from ..utility.redditinterface import RedditInterface
-from ..utility.exceptions import InitializationError
+from ..utility.miscellaneous import InitializationError
 
 T = TypeVar("T", bound=Program)
 
 
-class Plugin(Generic[T], ABC):
+class Plugin(Generic[T], metaclass=ABCMeta):
     """
-    Class responsible for generating multiple
-    instances of a specific program
+    Generates multiple instances of a specific program
     """
 
+    @abstractmethod
+    def get_program(self, reddit_interface: RedditInterface) -> T:
+        """Get new program instance"""
+        ...
+
+    @abstractmethod
+    def get_program_command(self) -> str:
+        """Get the program command string"""
+        ...
+
+    @abstractmethod
+    def is_shut_down(self) -> bool:
+        """Check if plugin is shut down"""
+        ...
+
+    @abstractmethod
+    def shut_down(self):
+        """Shut down the plugin"""
+        ...
+
+
+class AbstractPlugin(Generic[T], Plugin, metaclass=ABCMeta):
+
     _programCommand: str
     _pluginLogger: logging.Logger
     _isPluginShutDown: bool
@@ -29,33 +51,23 @@ class Plugin(Generic[T], ABC):
         )
         self._isPluginShutDown = False
 
-    @abstractmethod
-    def get_program(self, reddit_interface: RedditInterface) -> T:
-        """Get new program instance"""
-
-        raise NotImplementedError
-
     def get_program_command(self) -> str:
-        """Get the program command string"""
         return self._programCommand
 
     def is_shut_down(self) -> bool:
-        """Check if plugin is shut down"""
         return self._isPluginShutDown
 
     def shut_down(self):
-        """Shut down the plugin"""
         self._isPluginShutDown = True
 
     def __eq__(self, value) -> bool:
-        return isinstance(value, Plugin) and \
+        return isinstance(value, AbstractPlugin) and \
                self.get_program_command() == value.get_program_command()
 
 
 class PluginInitializationError(InitializationError):
     """
-    Class to encapsulate an error in the initialization
-    of a plugin module
+    Raised when initialization of a plugin module fails
     """
 
     def __init__(self, *args):

{redditadmin-0.0.6 → redditadmin-0.1.0}/src/redditadmin/plugin/pluginsexecutor.py

@@ -1,43 +1,54 @@
 # -*- coding: utf-8 -*-
 
 import logging
-from abc import ABC, abstractmethod
+from abc import ABCMeta, abstractmethod
 from typing import Dict
 
+from src.redditadmin.utility.miscellaneous import InitializationError
 
-class PluginsExecutor(ABC):
+
+class PluginsExecutor(metaclass=ABCMeta):
     """
-    Class responsible for executing plugins
+    Executes plugins
     """
 
-    _isPluginsExecutorShutDown: bool
-    _pluginsExecutorLogger: logging.Logger
-
-    def __init__(self, plugins_executor_name: str):
-        self._pluginsExecutorLogger = logging.getLogger(
-            plugins_executor_name
-        )
-        self._isPluginsExecutorShutDown = False
-
     @abstractmethod
     def execute_program(self, program_command):
         """Execute the provided program command"""
-
-        raise NotImplementedError
+        ...
 
     @abstractmethod
     def get_program_statuses(self) -> Dict[str, str]:
         """Get the executed program statuses"""
+        ...
 
-        raise NotImplementedError
-
+    @abstractmethod
     def shut_down(self, *args):
         """Shut down the plugins executor"""
+        ...
+
+    @abstractmethod
+    def is_shut_down(self) -> bool:
+        """Check if the Plugins Executor is shut down"""
+        ...
+
+
+class AbstractPluginsExecutor(PluginsExecutor, metaclass=ABCMeta):
+
+    _isPluginsExecutorShutDown: bool
+    _pluginsExecutorLogger: logging.Logger
+
+    def __init__(self, plugins_executor_name: str):
+        self._pluginsExecutorLogger = logging.getLogger(
+            plugins_executor_name
+        )
+        self._isPluginsExecutorShutDown = False
+
+    def shut_down(self, *args):
 
         self._isPluginsExecutorShutDown = True
 
     def is_shut_down(self) -> bool:
-        """Check if the Plugins Executor is shut down"""
 
         return self._isPluginsExecutorShutDown
 
@@ -52,3 +63,12 @@ class PluginsExecutor(ABC):
                 "The plugins executor cannot execute any more program "
                 "after it has been shut down"
             )
+
+
+class PluginsExecutorInitializationError(InitializationError):
+    """
+    Raised when initialization of a Plugins Executor module fails
+    """
+
+    def __init__(self, *args):
+        super().__init__(*args)

redditadmin-0.1.0/src/redditadmin/plugin/redditinterfacefactory.py

@@ -0,0 +1,47 @@
+from abc import ABCMeta, abstractmethod
+
+import praw
+
+from ..utility.botcredentials import BotCredentials, InvalidBotCredentialsError
+from ..utility.miscellaneous import is_reddit_authenticated
+from ..utility.redditinterface import RedditInterface, RedditInterfaceImplementation
+
+
+class RedditInterfaceFactory(metaclass=ABCMeta):
+    """Factory for RedditInterface objects"""
+
+    @abstractmethod
+    def get_reddit_interface(self) -> RedditInterface:
+        """Retrieve new Reddit Interface"""
+        ...
+
+
+class DefaultRedditInterfaceFactory(RedditInterfaceFactory):
+
+    def __init__(
+            self,
+            bot_credentials: BotCredentials
+    ):
+        praw_reddit = praw.Reddit(
+            user_agent=bot_credentials.user_agent,
+            client_id=bot_credentials.client_id,
+            client_secret=bot_credentials.client_secret,
+            username=bot_credentials.username,
+            password=bot_credentials.password
+        )
+        if not is_reddit_authenticated(praw_reddit):
+            raise InvalidBotCredentialsError
+
+        self.__botCredentials = bot_credentials
+
+    def get_reddit_interface(self):
+
+        bot_credentials = self.__botCredentials
+        praw_reddit = praw.Reddit(
+            user_agent=bot_credentials.user_agent,
+            client_id=bot_credentials.client_id,
+            client_secret=bot_credentials.client_secret,
+            username=bot_credentials.username,
+            password=bot_credentials.password
+        )
+        return RedditInterfaceImplementation(praw_reddit)

redditadmin-0.1.0/src/redditadmin/program/__init__.py

@@ -0,0 +1,5 @@
+from .program import Program as IProgram, AbstractProgram as Program,\
+    RecurringProgram as IRecurringProgram, AbstractRecurringProgram as RecurringProgram
+from .streamprocessingprogram import StreamProcessingProgram as IStreamProcessingProgram,\
+    AbstractStreamProcessingProgram as StreamProcessingProgram,\
+    StreamFactory, SubmissionStreamFactory, CommentStreamFactory, CustomStreamFactory