Unified ReportPortal product spelling

CHANGELOG.md

@@ -1,6 +1,8 @@
 # Changelog
 
 ## [Unreleased]
+### Changed
+- Unified ReportPortal product spelling, by @HardNorth
 
 ## [5.5.0]
 ### Added

README.md

@@ -8,7 +8,7 @@
 [![stackoverflow](https://img.shields.io/badge/reportportal-stackoverflow-orange.svg?style=flat)](http://stackoverflow.com/questions/tagged/reportportal)
 [![Build with Love](https://img.shields.io/badge/build%20with-❤%EF%B8%8F%E2%80%8D-lightgrey.svg)](http://reportportal.io?style=flat)
 
-Listener for RobotFramework to report results to Report Portal
+Listener for RobotFramework to report results to ReportPortal
 
 * [Installation](https://github.com/reportportal/agent-Python-RobotFramework#installation)
 * [Usage](https://github.com/reportportal/agent-Python-RobotFramework#usage)
@@ -30,7 +30,7 @@ The latest stable version of library is available on PyPI:
 
 ### Properties
 
-For reporting results to Report Portal you need to pass some variables
+For reporting results to ReportPortal you need to pass some variables
 to `robot` run:
 
 REQUIRED:
@@ -49,7 +49,7 @@ NOT REQUIRED:
 --variable RP_CLIENT_TYPE:"SYNC"
     - Type of the under-the-hood ReportPortal client implamentation. Possible values: [SYNC, ASYNC_THREAD, ASYNC_BATCHED].
 --variable RP_LAUNCH_UUID:"id_of_existing_rp_launch"
-    - ID of existing Report Portal launch
+    - ID of existing ReportPortal launch
 --variable RP_LAUNCH_DOC:"some_documentation_for_launch"
     - Description for the launch
 --variable RP_LAUNCH_ATTRIBUTES:"RF tag_name:tag_value"
@@ -117,19 +117,19 @@ def log_free_memory():
 
 It's possible to tag tests the following way `test_case_id:12345` using default
 Robot Framework tagging functionality. ID specified after `:` will be sent to
-Report Portal.
+ReportPortal.
 
 ## Send attachment (screenshots)
 
 https://github.com/reportportal/client-Python#send-attachement-screenshots
 
 ## Integration with GA
 
-Report Portal is now supporting integrations with more than 15 test frameworks
+ReportPortal is now supporting integrations with more than 15 test frameworks
 simultaneously. In order to define the most popular agents and plan the team
 workload accordingly, we are using Google analytics.
 
-Report Portal collects information about agent name and its version only. This
+ReportPortal collects information about agent name and its version only. This
 information is sent to Google analytics on the launch start. Please help us to
 make our work effective.
 If you still want to switch Off Google analytics, please change env variable

examples/library/Log.py

@@ -21,7 +21,7 @@
 
 def screenshot_log(level, message, screenshot_file):
     """
-    Attach a screenshot file into a log entry on Report Portal.
+    Attach a screenshot file into a log entry on ReportPortal.
 
     :param level: log entry level
     :param message: screenshot description

robotframework_reportportal/__init__.py

@@ -11,4 +11,4 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License
 
-"""This package contains modules for reporting to Report Portal."""
+"""This package contains modules for reporting to ReportPortal."""

robotframework_reportportal/listener.py

@@ -44,7 +44,7 @@ def wrap(*args, **kwargs):
 
 # noinspection PyPep8Naming
 class listener:
-    """Robot Framework listener interface for reporting to Report Portal."""
+    """Robot Framework listener interface for reporting to ReportPortal."""
 
     _items: LifoQueue = ...
     _service: Optional[RobotService] = ...
@@ -86,7 +86,7 @@ def current_item(self) -> Optional[Union[Keyword, Launch, Suite, Test]]:
 
     @check_rp_enabled
     def log_message(self, message: Dict) -> None:
-        """Send log message to the Report Portal.
+        """Send log message to the ReportPortal.
 
         :param message: Message passed by the Robot Framework
         """
@@ -96,7 +96,7 @@ def log_message(self, message: Dict) -> None:
 
     @check_rp_enabled
     def log_message_with_image(self, msg: Dict, image: str):
-        """Send log message to the Report Portal.
+        """Send log message to the ReportPortal.
 
         :param msg:   Message passed by the Robot Framework
         :param image: Path to image
@@ -134,7 +134,7 @@ def variables(self) -> Variables:
 
     @check_rp_enabled
     def start_launch(self, attributes: Dict, ts: Optional[Any] = None) -> None:
-        """Start a new launch at the Report Portal.
+        """Start a new launch at the ReportPortal.
 
         :param attributes: Dictionary passed by the Robot Framework
         :param ts:         Timestamp(used by the ResultVisitor)
@@ -158,7 +158,7 @@ def start_launch(self, attributes: Dict, ts: Optional[Any] = None) -> None:
 
     @check_rp_enabled
     def start_suite(self, name: str, attributes: Dict, ts: Optional[Any] = None) -> None:
-        """Start a new test suite at the Report Portal.
+        """Start a new test suite at the ReportPortal.
 
         :param name:       Test suite name
         :param attributes: Dictionary passed by the Robot Framework
@@ -183,7 +183,7 @@ def start_suite(self, name: str, attributes: Dict, ts: Optional[Any] = None) ->
 
     @check_rp_enabled
     def end_suite(self, _: Optional[str], attributes: Dict, ts: Optional[Any] = None) -> None:
-        """Finish started test suite at the Report Portal.
+        """Finish started test suite at the ReportPortal.
 
         :param attributes: Dictionary passed by the Robot Framework
         :param ts:         Timestamp(used by the ResultVisitor)
@@ -205,7 +205,7 @@ def end_suite(self, _: Optional[str], attributes: Dict, ts: Optional[Any] = None
 
     @check_rp_enabled
     def start_test(self, name: str, attributes: Dict, ts: Optional[Any] = None) -> None:
-        """Start a new test case at the Report Portal.
+        """Start a new test case at the ReportPortal.
 
         :param name:       Test case name
         :param attributes: Dictionary passed by the Robot Framework
@@ -225,7 +225,7 @@ def start_test(self, name: str, attributes: Dict, ts: Optional[Any] = None) -> N
 
     @check_rp_enabled
     def end_test(self, _: Optional[str], attributes: Dict, ts: Optional[Any] = None) -> None:
-        """Finish started test case at the Report Portal.
+        """Finish started test case at the ReportPortal.
 
         :param attributes: Dictionary passed by the Robot Framework
         :param ts:         Timestamp(used by the ResultVisitor)
@@ -243,7 +243,7 @@ def end_test(self, _: Optional[str], attributes: Dict, ts: Optional[Any] = None)
 
     @check_rp_enabled
     def start_keyword(self, name: str, attributes: Dict, ts: Optional[Any] = None) -> None:
-        """Start a new keyword(test step) at the Report Portal.
+        """Start a new keyword(test step) at the ReportPortal.
 
         :param name:       Keyword name
         :param attributes: Dictionary passed by the Robot Framework
@@ -258,7 +258,7 @@ def start_keyword(self, name: str, attributes: Dict, ts: Optional[Any] = None) -
 
     @check_rp_enabled
     def end_keyword(self, _: Optional[str], attributes: Dict, ts: Optional[Any] = None) -> None:
-        """Finish started keyword at the Report Portal.
+        """Finish started keyword at the ReportPortal.
 
         :param attributes: Dictionary passed by the Robot Framework
         :param ts:         Timestamp(used by the ResultVisitor)

robotframework_reportportal/logger.py

@@ -12,7 +12,7 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
-"""Report Portal logging API for test libraries with support for attachments.
+"""ReportPortal logging API for test libraries with support for attachments.
 
 Usage of this logger is similar to the standard robot.api.logger with addition
 of an extra kwarg "attachment" to all logging functions.

robotframework_reportportal/model.py

@@ -180,7 +180,7 @@ def __init__(self, name, attributes, parent_type=None):
         self.type = 'KEYWORD'
 
     def get_name(self):
-        """Get name of the keyword suitable for Report Portal."""
+        """Get name of the keyword suitable for ReportPortal."""
         assign = ', '.join(self.assign)
         assignment = '{0} = '.format(assign) if self.assign else ''
         arguments = ', '.join(self.args)

robotframework_reportportal/post_report.py

@@ -12,7 +12,7 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
-"""Robot Framework test report sender to Report Portal.
+"""Robot Framework test report sender to ReportPortal.
 
 This tool replays a Robot Framework test session using the output XML file
 with ReportPortal's listener agent injected without actually doing the test.

robotframework_reportportal/service.py

@@ -12,7 +12,7 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
-"""This module is a Robot service for reporting results to Report Portal."""
+"""This module is a Robot service for reporting results to ReportPortal."""
 
 from typing import Optional
 
@@ -53,7 +53,7 @@ def to_epoch(date: Optional[str]) -> Optional[str]:
 
 
 class RobotService(object):
-    """Class represents service that sends Robot items to Report Portal."""
+    """Class represents service that sends Robot items to ReportPortal."""
 
     agent_name: str
     agent_version: str
@@ -77,9 +77,9 @@ def _get_launch_attributes(self, cmd_attrs: list) -> list:
         return attributes + dict_to_payload(system_attributes)
 
     def init_service(self, variables: Variables) -> None:
-        """Initialize common Report Portal client.
+        """Initialize common ReportPortal client.
 
-        :param variables: Report Portal variables
+        :param variables: ReportPortal variables
         """
         if self.rp is None:
             logger.debug(f'ReportPortal - Init service: endpoint={variables.endpoint}, '
@@ -261,7 +261,7 @@ def finish_keyword(self, keyword: Keyword, issue: Optional[str] = None, ts: Opti
         self.rp.finish_test_item(**fta_rq)
 
     def log(self, message: LogMessage, ts: Optional[str] = None):
-        """Send log message to Report Portal.
+        """Send log message to ReportPortal.
 
         :param message: model.LogMessage object
         :param ts:      Timestamp

robotframework_reportportal/variables.py

@@ -40,7 +40,7 @@ def get_variable(name: str, default: Optional[str] = None) -> Optional[str]:
 
 
 class Variables:
-    """This class stores Robot Framework variables related to Report Portal."""
+    """This class stores Robot Framework variables related to ReportPortal."""
 
     enabled: bool = ...
     endpoint: Optional[str] = ...
@@ -142,8 +142,8 @@ def __init__(self) -> None:
         self.enabled = all(cond)
         if not self.enabled:
             warn(
-                'One or required parameter is missing, Report Portal listener '
-                'will be disabled. Please check agent documentation.',
+                'One or required parameter is missing, ReportPortal listener will be disabled. '
+                'Please check agent documentation.',
                 RuntimeWarning,
                 2
             )

setup.py

@@ -36,11 +36,10 @@ def read_file(fname):
     packages=['robotframework_reportportal'],
     package_data={'robotframework_reportportal': ['*.pyi']},
     version=__version__,
-    description='Agent for reporting RobotFramework test results to '
-                'Report Portal',
+    description='Agent for reporting RobotFramework test results to ReportPortal',
     long_description=read_file('README.md'),
     long_description_content_type='text/markdown',
-    author='Report Portal Team',
+    author='ReportPortal Team',
     author_email='[email protected]',
     url='https://github.com/reportportal/agent-Python-RobotFramework',
     download_url=(