fusion-platform-python-sdk 1.15.11__tar.gz → 1.15.12__tar.gz

{fusion_platform_python_sdk-1.15.11/fusion_platform_python_sdk.egg-info → fusion_platform_python_sdk-1.15.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fusion-platform-python-sdk
-Version: 1.15.11
+Version: 1.15.12
 Summary: Python SDK used to interact with the Fusion Platform(r)
 Home-page: https://github.com/d-cat-support/fusion-platform-python-sdk
 Author: Digital Content Analysis Technology Ltd

{fusion_platform_python_sdk-1.15.11 → fusion_platform_python_sdk-1.15.12}/fusion_platform/__init__.py

@@ -11,8 +11,8 @@ API, and this is defined within the corresponding OpenAPI 3.0 specification, whi
 """
 
 # Do not modify the following two lines as they are maintained by the version.sh script.
-__version__ = '1.15.11'
-__version_date__ = '2024-12-13T13:48:29Z'
+__version__ = '1.15.12'
+__version_date__ = '2024-12-20T11:33:56Z'
 
 # Exclude certain sub-modules from documentation.
 # @formatter:off

{fusion_platform_python_sdk-1.15.11 → fusion_platform_python_sdk-1.15.12}/fusion_platform/base.py

@@ -31,7 +31,7 @@ class Base:
         Localise.setup()
 
         # Set up logging.
-        logging.basicConfig(format='%(asctime)s.%(msecs)03d [%(levelname)s] %(pathname)s:%(funcName)s:%(lineno)d - %(message)s')
+        logging.basicConfig(format='%(asctime)s.%(msecs)03d [%(levelname)s] %(filename)s:%(funcName)s:%(lineno)d - %(message)s')
         self._logger = logging.getLogger(fusion_platform.FUSION_PLATFORM_LOGGER)
         self._logger.debug('sdk %s (%s): %s', fusion_platform.__version__, fusion_platform.__version_date__, self.__class__.__name__)
 

{fusion_platform_python_sdk-1.15.11 → fusion_platform_python_sdk-1.15.12}/fusion_platform/command.py

@@ -345,6 +345,60 @@ class Command(Base):
 
         return process_definition
 
+    def display_service(self, organisation, service_name):
+        """
+        Displays the documentation for the service. If the service does not exist, it will be ignored.
+
+        Args:
+            organisation: The logged in organisation.
+            service_name: The name of the service to display.
+
+        Returns:
+            True if a service was displayed.
+        """
+        found = False
+
+        # Try to find any existing service, ignoring any error.
+        try:
+            service = self.get_service(organisation, service_name)
+            found = True
+
+            self.__print_service(service)
+
+        except CommandError as e:
+            self.__print(logging.DEBUG, str(e))
+
+        return found
+
+    def display_process(self, organisation, process_name):
+        """
+        Displays the current configuration of the process. If the process does not exist, it will be ignored.
+
+        Args:
+            organisation: The logged in organisation.
+            process_name: The name of the process to display.
+
+        Returns:
+            True if a process was displayed.
+        """
+        found = False
+
+        # Try to find any existing process, ignoring any error.
+        try:
+            process, _ = self.get_process_or_execution(organisation, process_name)
+            found = True
+
+            self.__print_process(process)
+
+            # Display the status of any execution.
+            for execution in process.executions:
+                self.__print_execution(execution)
+
+        except CommandError as e:
+            self.__print(logging.DEBUG, str(e))
+
+        return found
+
     def __download_execution(self, process, download_inputs, download_outputs, download_storage, download_intermediate, download_components, output_dir, execution):
         """
         Downloads an execution.
@@ -756,10 +810,13 @@ class Command(Base):
 
         Args:
             organisation: The logged in organisation.
-            process_name: The name of the process to be downloaded. This can also be the id of a process or an execution.
+            process_name: The name of the process. This can also be the id of a process or an execution.
 
         Returns:
             The found process and/or execution.
+
+        Raises:
+            CommandError: if a process or execution could not be found.
         """
 
         # Attempt to find the process.
@@ -782,6 +839,37 @@ class Command(Base):
 
         return process, execution
 
+    def get_service(self, organisation, service_name):
+        """
+        Attempts to find a service using the given service name, service id or SSD id.
+
+        Args:
+            organisation: The logged in organisation.
+            service_name: The name of the service. This can also be the id or SSD id of a service.
+
+        Returns:
+            The found service.
+
+        Raises:
+            CommandError: if a service could not be found.
+        """
+
+        # Find the service using its case-sensitive name (starts with).
+        service, _ = organisation.find_services(name=service_name)
+
+        # If the service cannot be found, try to find it by its id or SSD id.
+        if service is None:
+            service = next((item for item in organisation.services if (str(item.id) == service_name) or (str(item.ssd_id) == service_name)), None)
+
+        # If the service still cannot be found, then try it as a specific service for the organisation.
+        if service is None:
+            service = next((item for item in organisation.own_services if (str(item.id) == service_name) or (str(item.ssd_id) == service_name)), None)
+
+        if service is None:
+            raise CommandError(i18n.t('command.no_such_service', service=service_name))
+
+        return service
+
     def __get_storage_data_item(self, process, group_index, group_count, ssd_id, chain_index):
         """
         Gets the storage date item for a process' group and chain index.
@@ -897,6 +985,7 @@ class Command(Base):
         self._logger.setLevel(logging.CRITICAL)
 
         if arguments.debug:
+            self._logger.setLevel(logging.DEBUG)
             self.__print_level = logging.DEBUG
         else:
             self.__print_level = logging.INFO
@@ -905,8 +994,15 @@ class Command(Base):
             # Login to the correct deployment and select the organisation.
             organisation, _, _ = self.login(arguments.deployment, arguments.email, arguments.organisation)
 
-            # Perform the start, define or download.
-            if arguments.command == i18n.t('command.start.command'):
+            # Perform the display, start, define or download.
+            if arguments.command == i18n.t('command.display.command'):
+                # Display a service or process with the specified name or ids. If a service is displayed, we do not display a process.
+                for process_or_service in arguments.process_or_service:
+                    if not self.display_service(organisation, process_or_service):
+                        if not self.display_process(organisation, process_or_service):
+                            self.__print(logging.WARNING, i18n.t('command.no_process_or_service', process_or_service=process_or_service))
+
+            elif arguments.command == i18n.t('command.start.command'):
                 # Start one or more processes.
                 for service_or_yaml in arguments.service_or_yaml:
                     # Extract the command line or YAML file arguments.
@@ -983,12 +1079,13 @@ class Command(Base):
                             version=i18n.t('command.version_content', version=fusion_platform.__version__, version_date=fusion_platform.__version_date__))
 
         subparsers.required = True
+        parser_display = subparsers.add_parser(i18n.t('command.display.command'), help=i18n.t('command.display.help'))
         parser_start = subparsers.add_parser(i18n.t('command.start.command'), help=i18n.t('command.start.help'))
         parser_define = subparsers.add_parser(i18n.t('command.define.command'), help=i18n.t('command.define.help'))
         parser_download = subparsers.add_parser(i18n.t('command.download.command'), help=i18n.t('command.download.help'))
 
         # Add in the common arguments.
-        for subparser in [parser_start, parser_define, parser_download]:
+        for subparser in [parser_display, parser_start, parser_define, parser_download]:
             subparser.add_argument(i18n.t('command.deployment_short'), i18n.t('command.deployment_long'), help=i18n.t('command.deployment_help'),
                                    default=Command._DEPLOYMENT_PRODUCTION_IRL)
             subparser.add_argument(i18n.t('command.email_short'), i18n.t('command.email_long'), help=i18n.t('command.email_help'))
@@ -996,6 +1093,9 @@ class Command(Base):
             subparser.add_argument(i18n.t('command.debug_short'), i18n.t('command.debug_long'), help=i18n.t('command.debug_help'), default=False,
                                    action="store_true")
 
+        # Display arguments.
+        parser_display.add_argument(i18n.t('command.display.service_or_process_long'), help=i18n.t('command.display.service_or_process_help'), nargs='+')
+
         # Start arguments.
         parser_start.add_argument(i18n.t('command.start.definition_long'), help=i18n.t('command.start.definition_help'), nargs='+')
         parser_start.add_argument(i18n.t('command.start.input_list_short'), i18n.t('command.start.input_list_long'), help=i18n.t('command.start.input_list_help'),
@@ -1062,6 +1162,48 @@ class Command(Base):
             else:
                 print(message)
 
+    def __print_execution(self, execution):
+        """
+        Prints an execution. This just shows the status in a simple format.
+
+        Args:
+            execution: The execution to be logged.
+        """
+
+        # Form the status of the execution.
+        status = ''
+        group = ''
+
+        if execution.success:
+            status = i18n.t('command.log_execution_success')
+
+        elif execution.stopped:
+            status = i18n.t('command.log_execution_stopped')
+
+        elif execution.progress < 100:
+            status = i18n.t('command.log_execution_progress', progress=execution.progress)
+
+        else:
+            abort_reason = i18n.t('command.log_execution_abort_reason', abort_reason=execution.abort_reason) if hasattr(execution,
+                                                                                                                        Model._FIELD_ABORT_REASON) else ''
+            exit_type = i18n.t('command.log_execution_exit_type', exit_type=execution.exit_type) if hasattr(execution, Model._FIELD_EXIT_TYPE) else ''
+            status = i18n.t('command.log_execution_failed', exit_type=exit_type, abort_reason=abort_reason)
+
+        started_at = execution.started_at.strftime('%Y-%m-%d %H:%M:%S')
+        ended_at = i18n.t('command.log_execution_ended_at', ended_at=execution.ended_at.strftime('%Y-%m-%d %H:%M:%S')) if hasattr(execution,
+                                                                                                                                  Model._FIELD_ENDED_AT) else ''
+        period = i18n.t('command.log_execution_period', started_at=started_at, ended_at=ended_at)
+        duration = i18n.t('command.log_execution_duration', minutes=round((execution.ended_at - execution.started_at).total_seconds() // 60)) if hasattr(execution,
+                                                                                                                                                         Model._FIELD_ENDED_AT) and (
+                                                                                                                                                         execution.ended_at is not None) else ''
+
+        if (hasattr(execution, Model._FIELD_GROUP_ID) and (execution.group_id is not None)) and (
+                hasattr(execution, Model._FIELD_GROUP_INDEX) and (execution.group_index is not None)) and (
+                hasattr(execution, Model._FIELD_GROUP_COUNT) and (execution.group_count is not None)):
+            group = i18n.t('command.log_execution_group', group_id=execution.group_id, group_index=execution.group_index, group_count=execution.group_count)
+
+        self.__print(logging.INFO, i18n.t('command.log_execution', id=execution.id, period=period, status=status, duration=duration, group=group))
+
     def __print_process(self, process):
         """
         Prints a process.
@@ -1076,26 +1218,88 @@ class Command(Base):
             if hasattr(process, field):
                 self.__print(logging.INFO, i18n.t('command.log_field', field=field, value=getattr(process, field)))
 
-        self.__print(logging.INFO, i18n.t('command.log_divider'))
-        self.__print(logging.INFO, i18n.t('command.log_inputs'))
+        process_inputs = [input for input in process.inputs]
+
+        if len(process_inputs) > 0:
+            self.__print(logging.INFO, i18n.t('command.log_divider'))
+            self.__print(logging.INFO, i18n.t('command.log_inputs'))
+
+            for data_item in process_inputs:
+                self.__print(logging.INFO, str(data_item), format=False)
+
+        process_options = [option for option in process.options]
+
+        if len(process_options) > 0:
+            self.__print(logging.INFO, i18n.t('command.log_divider'))
+            self.__print(logging.INFO, i18n.t('command.log_options'))
+
+            for option in process_options:
+                self.__print(logging.INFO, str(option), format=False)
+
+        process_dispatchers = [dispatcher for dispatcher in process.dispatchers]
+
+        if len(process_dispatchers) > 0:
+            self.__print(logging.INFO, i18n.t('command.log_divider'))
+            self.__print(logging.INFO, i18n.t('command.log_dispatchers'))
 
-        for data_item in process.inputs:
-            self.__print(logging.INFO, str(data_item), format=False)
+            for dispatcher in process_dispatchers:
+                self.__print(logging.INFO, i18n.t('command.log_subdivider'))
+                self.__print(logging.INFO, str(dispatcher), format=False)
+
+                for option in dispatcher.options:
+                    self.__print(logging.INFO, str(option), format=False)
+
+        self.__print(logging.INFO, i18n.t('command.log_bookend'))
+
+    def __print_service(self, service):
+        """
+        Prints the documentation for a service.
+
+        Args:
+            service: The service to be logged.
+        """
+        self.__print(logging.INFO, i18n.t('command.log_bookend'))
+        self.__print(logging.INFO, i18n.t('command.log_service', service=service.name))
+
+        self.__print(logging.INFO, i18n.t('command.log_field', field=Model._FIELD_CATEGORIES, value=service.categories))
+        self.__print(logging.INFO, i18n.t('command.log_field', field=Model._FIELD_KEYWORDS, value=service.keywords))
 
         self.__print(logging.INFO, i18n.t('command.log_divider'))
-        self.__print(logging.INFO, i18n.t('command.log_options'))
+        self.__print(logging.INFO, i18n.t('command.log_summary'))
+        self.__print(logging.INFO, service.documentation_summary, format=False)
 
-        for option in process.options:
-            self.__print(logging.INFO, str(option), format=False)
+        self.__print(logging.INFO, i18n.t('command.log_divider'))
+        self.__print(logging.INFO, i18n.t('command.log_description'))
+        self.__print(logging.INFO, service.documentation_description, format=False)
 
         self.__print(logging.INFO, i18n.t('command.log_divider'))
-        self.__print(logging.INFO, i18n.t('command.log_dispatchers'))
+        self.__print(logging.INFO, i18n.t('command.log_assumptions'))
+        self.__print(logging.INFO, service.documentation_assumptions, format=False)
+
+        if len(service.documentation_actions.strip()) > 0:
+            self.__print(logging.INFO, i18n.t('command.log_divider'))
+            self.__print(logging.INFO, i18n.t('command.log_actions'))
+            self.__print(logging.INFO, service.documentation_actions, format=False)
 
-        for dispatcher in process.dispatchers:
-            self.__print(logging.INFO, i18n.t('command.log_subdivider'))
-            self.__print(logging.INFO, str(dispatcher), format=False)
+        if hasattr(service, Model._FIELD_DOCUMENTATION_INPUTS):
+            self.__print(logging.INFO, i18n.t('command.log_divider'))
+            self.__print(logging.INFO, i18n.t('command.log_inputs'))
 
-            for option in dispatcher.options:
+            for input in service.documentation_inputs:
+                self.__print(logging.INFO, str(input), format=False)
+
+        if hasattr(service, Model._FIELD_DOCUMENTATION_OUTPUTS):
+            self.__print(logging.INFO, i18n.t('command.log_divider'))
+            self.__print(logging.INFO, i18n.t('command.log_outputs'))
+
+            for output in service.documentation_outputs:
+                self.__print(logging.INFO, str(output), format=False)
+
+        if hasattr(service, Model._FIELD_DOCUMENTATION_OPTIONS):
+            self.__print(logging.INFO, i18n.t('command.log_divider'))
+            self.__print(logging.INFO, i18n.t('command.log_options'))
+
+            for option in service.documentation_options:
                 self.__print(logging.INFO, str(option), format=False)
 
         self.__print(logging.INFO, i18n.t('command.log_bookend'))
@@ -1237,16 +1441,8 @@ class Command(Base):
         else:
             data_items = []
 
-        # Find the service using its case-sensitive name (starts with).
-        service, _ = organisation.find_services(name=service_name)
-
-        # If the service cannot be found, then try it as a specific service for the organisation.
-        if service is None:
-            service = next((item for item in organisation.own_services if item.name == service_name), None)
-
-        if service is None:
-            raise CommandError(i18n.t('command.no_such_service', service=service_name))
-
+        # Find the service.
+        service = self.get_service(organisation, service_name)
         self.__print(logging.DEBUG, i18n.t('command.using_service', service=service.name))
 
         # Create the process with its options and inputs.

{fusion_platform_python_sdk-1.15.11 → fusion_platform_python_sdk-1.15.12}/fusion_platform/models/model.py

@@ -45,9 +45,11 @@ class Model(Base):
     _EXTRAS_LIST = None
 
     # Useful fields and templates.
+    _FIELD_ABORT_REASON = 'abort_reason'
     _FIELD_AVAILABLE_DISPATCHERS = 'available_dispatchers'
     _FIELD_BOUNDS = 'bounds'
     _FIELD_CATEGORY = 'category'
+    _FIELD_CATEGORIES = 'categories'
     _FIELD_CHAINS = 'chains'
     _FIELD_CHAIN_INDEX = 'chain_index'
     _FIELD_CONSTRAINED_NAMES = 'constrained_names'
@@ -58,8 +60,13 @@ class Model(Base):
     _FIELD_DISPATCHERS = 'dispatchers'
     _FIELD_DOCUMENTATION_SUMMARY = 'documentation_summary'
     _FIELD_DOCUMENTATION_DESCRIPTION = 'documentation_description'
+    _FIELD_DOCUMENTATION_INPUTS = 'documentation_inputs'
+    _FIELD_DOCUMENTATION_OUTPUTS = 'documentation_outputs'
+    _FIELD_DOCUMENTATION_OPTIONS = 'documentation_options'
+    _FIELD_ENDED_AT = 'ended_at'
     _FIELD_ERROR = 'error'
     _FIELD_EXECUTIONS = 'executions'
+    _FIELD_EXIT_TYPE = 'exit_type'
     _FIELD_EXTENSIONS = 'extensions'
     _FIELD_FILE = 'file'
     _FIELD_FILE_NAME = 'file_name'

{fusion_platform_python_sdk-1.15.11 → fusion_platform_python_sdk-1.15.12}/fusion_platform/translations.py

@@ -13,19 +13,37 @@ import i18n
 # @formatter:off
 i18n.add_translation('command.validate_constrained_error', 'Not one of %{constrained}', 'en')
 i18n.add_translation('command.unknown_command', 'Unknown command \'%{command}\'', 'en')
+i18n.add_translation('command.no_process_or_service', 'No such service, process or execution \'%{process_or_service}\'', 'en')
 i18n.add_translation('command.no_such_service', 'No such service \'%{service}\'', 'en')
 i18n.add_translation('command.no_such_process', 'No such process or execution \'%{process}\'', 'en')
 i18n.add_translation('command.no_such_organisation', 'No such organisation \'%{organisation}\'', 'en')
 i18n.add_translation('command.no_such_input', 'No such input \'%{input_name}\'', 'en')
 i18n.add_translation('command.no_executions', 'No executions for process \'%{process}\'', 'en')
 i18n.add_translation('command.invalid_login_response', 'Incorrect username or password', 'en')
-i18n.add_translation('command.log_subdivider', '................................................................................................', 'en')
-i18n.add_translation('command.log_process', 'Process \'%{process}\'', 'en')
+i18n.add_translation('command.log_execution_group', ' (group \'%{group_id}\' %{group_index} of %{group_count})', 'en')
+i18n.add_translation('command.log_execution_duration', ' - %{minutes} minute(s)', 'en')
+i18n.add_translation('command.log_execution_period', ' (%{started_at}%{ended_at})', 'en')
+i18n.add_translation('command.log_execution_ended_at', ' -> %{ended_at}', 'en')
+i18n.add_translation('command.log_execution_failed', 'failed%{exit_type}%{abort_reason}', 'en')
+i18n.add_translation('command.log_execution_exit_type', ' (%{exit_type})', 'en')
+i18n.add_translation('command.log_execution_abort_reason', ': %{abort_reason}', 'en')
+i18n.add_translation('command.log_execution_stopped', 'stopped', 'en')
+i18n.add_translation('command.log_execution_progress', 'processing %{progress}%%', 'en')
+i18n.add_translation('command.log_execution_success', 'success', 'en')
+i18n.add_translation('command.log_actions', 'Actions:', 'en')
+i18n.add_translation('command.log_assumptions', 'Assumptions:', 'en')
+i18n.add_translation('command.log_description', 'Description:', 'en')
+i18n.add_translation('command.log_summary', 'Summary:', 'en')
+i18n.add_translation('command.log_dispatchers', 'Dispatchers:', 'en')
 i18n.add_translation('command.log_options', 'Options:', 'en')
+i18n.add_translation('command.log_outputs', 'Outputs:', 'en')
 i18n.add_translation('command.log_inputs', 'Inputs:', 'en')
+i18n.add_translation('command.log_execution', 'Execution \'%{id}\'%{period}: %{status}%{duration}%{group}', 'en')
+i18n.add_translation('command.log_service', 'Service \'%{service}\'', 'en')
+i18n.add_translation('command.log_process', 'Process \'%{process}\'', 'en')
 i18n.add_translation('command.log_field', '%{field}: %{value}', 'en')
+i18n.add_translation('command.log_subdivider', '................................................................................................', 'en')
 i18n.add_translation('command.log_divider', '------------------------------------------------------------------------------------------------', 'en')
-i18n.add_translation('command.log_dispatchers', 'Dispatchers:', 'en')
 i18n.add_translation('command.log_bookend', '************************************************************************************************', 'en')
 i18n.add_translation('command.wait_for_next', 'Waiting for next execution...', 'en')
 i18n.add_translation('command.using_storage', 'Uploading storage \'%{filename}\' with id %{storage_id} to \'%{storage_name}\'', 'en')
@@ -97,7 +115,11 @@ i18n.add_translation('command.start.definition_help', 'the names of the service
 i18n.add_translation('command.start.definition_long', 'service_or_yaml', 'en')
 i18n.add_translation('command.start.help', 'starts a process', 'en')
 i18n.add_translation('command.start.command', 'start', 'en')
-i18n.add_translation('command.subparser', 'starts, defines or downloads a process', 'en')
+i18n.add_translation('command.display.service_or_process_help', 'the names of the service, id, SSD id, process, process id or associated execution id that are to be displayed', 'en')
+i18n.add_translation('command.display.service_or_process_long', 'process_or_service', 'en')
+i18n.add_translation('command.display.help', 'displays service information or a configured process', 'en')
+i18n.add_translation('command.display.command', 'display', 'en')
+i18n.add_translation('command.subparser', 'displays a service or process, or starts, defines or downloads a process', 'en')
 i18n.add_translation('command.version_content', '%%(prog)s %{version} (%{version_date})', 'en')
 i18n.add_translation('command.version_help', 'show the version information and exit', 'en')
 i18n.add_translation('command.version_long', '--version', 'en')
@@ -117,18 +139,26 @@ i18n.add_translation('command.deployment_short', '-y', 'en')
 i18n.add_translation('command.epilog', '''
 For more detailed options, use:
 
+  fusion_platform display --help
   fusion_platform start --help
   fusion_platform define --help
   fusion_platform download --help
 
 ''', 'en')
 i18n.add_translation('command.description', '''
-Use this command to execute any service (by case-sensitive name) or to retrieve its inputs and outputs. The service can be selected via command line options or
-defined by a YAML file. This command can also be used to build a YAML file from an existing process.
+Use this command to display service information and processes, and to start, download or define processes. Processes can be selected via command line options or
+defined by a YAML file.
 
 Usage:
-  The following will attempt to create one or more processes from the given \'service_name\' to use the inputs (in order) and options and execute them. All processes
-  will use the same inputs and options:
+  The following will display information about one or more services or processes from the given \'service_or_process_name\'.
+
+    fusion_platform display <service_or_process_name> ...
+
+  For a service, this will display the full service documentation, including its expected inputs and options. For a process, it will show the current process
+  configuration.
+
+  The following will attempt to create one or more processes from the given \'service_name\' to use the inputs (in order) and options and execute them. All
+  processes will use the same inputs and options:
 
     fusion_platform start <service_name> ... -l <input_file|input_name> ... -p <option=value> ...
 

{fusion_platform_python_sdk-1.15.11 → fusion_platform_python_sdk-1.15.12/fusion_platform_python_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fusion-platform-python-sdk
-Version: 1.15.11
+Version: 1.15.12
 Summary: Python SDK used to interact with the Fusion Platform(r)
 Home-page: https://github.com/d-cat-support/fusion-platform-python-sdk
 Author: Digital Content Analysis Technology Ltd

{fusion_platform_python_sdk-1.15.11 → fusion_platform_python_sdk-1.15.12}/setup.py

@@ -19,7 +19,7 @@ PACKAGE_DIR = pathlib.Path(__file__).parent
 # @formatter:off
 setup(
     name='fusion-platform-python-sdk',
-    version='1.15.11',
+    version='1.15.12',
     description='Python SDK used to interact with the Fusion Platform(r)',
     long_description=(PACKAGE_DIR / 'README.md').read_text(),
     long_description_content_type='text/markdown',