Merge pull request crs4#139 from kikkomep/refactor/reorganize-utils-package

refactor: reorganize utils package

Author: kikkomep

docs/3_usage_api.rst

@@ -69,7 +69,7 @@ Formatting Validation Results
 Validation results can be rendered using different output formatters provided by
 the library. Two formatter types are available: *text* and *JSON*.  
 Both rely on the ``rich`` Python library and integrate with the
-``rocrate_validator.io.output.console.Console`` class, which extends
+``rocrate_validator.utils.io_helpers.output.console.Console`` class, which extends
 ``rich.console.Console`` to support custom formatter registration.
 
 To format results, create a ``Console`` instance, register one formatter,
@@ -86,8 +86,8 @@ to a file.
 
 .. code-block:: python
 
-    from rocrate_validator.io.output.console import Console
-    from rocrate_validator.io.output.text import TextOutputFormatter
+    from rocrate_validator.utils.io_helpers.output.console import Console
+    from rocrate_validator.utils.io_helpers.output.text import TextOutputFormatter
 
     console = Console()
     console.register_formatter(TextOutputFormatter())
@@ -114,8 +114,8 @@ programmatic processing, or integration with external tools.
 
 .. code-block:: python
 
-    from rocrate_validator.io.output.console import Console
-    from rocrate_validator.io.output.json import JSONOutputFormatter
+    from rocrate_validator.utils.io_helpers.output.console import Console
+    from rocrate_validator.utils.io_helpers.output.json import JSONOutputFormatter
 
     console = Console()
     console.register_formatter(JSONOutputFormatter())

rocrate_validator/__init__.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 def get_version():
-    from rocrate_validator.utils import get_version
+    from rocrate_validator.utils.versioning import get_version
     return get_version()
 
 

rocrate_validator/cli/commands/errors.py

@@ -17,7 +17,7 @@
 
 from rich.console import Console
 
-import rocrate_validator.log as logging
+from rocrate_validator.utils import log as logging
 from rocrate_validator.errors import (InvalidProfilePath, ProfileNotFound,
                                       ProfilesDirectoryNotFound)
 

rocrate_validator/cli/commands/profiles.py

@@ -21,16 +21,17 @@
 from rich.panel import Panel
 from rich.table import Table
 
-import rocrate_validator.log as logging
 from rocrate_validator import services
 from rocrate_validator.cli.commands.errors import handle_error
 from rocrate_validator.cli.main import cli, click
-from rocrate_validator.colors import get_severity_color
 from rocrate_validator.constants import DEFAULT_PROFILE_IDENTIFIER
-from rocrate_validator.rocv_io.output.text.layout.report import get_app_header_rule
 from rocrate_validator.models import (LevelCollection, RequirementLevel,
                                       Severity)
-from rocrate_validator.utils import get_profiles_path, shorten_path
+from rocrate_validator.utils import log as logging
+from rocrate_validator.utils.io_helpers.colors import get_severity_color
+from rocrate_validator.utils.io_helpers.output.text.layout.report import \
+    get_app_header_rule
+from rocrate_validator.utils.paths import get_profiles_path, shorten_path
 
 # set the default profiles path
 DEFAULT_PROFILES_PATH = get_profiles_path()

rocrate_validator/cli/commands/validate.py

@@ -23,21 +23,22 @@
 from rich.padding import Padding
 from rich.rule import Rule
 
-import rocrate_validator.log as logging
+from rocrate_validator.utils import log as logging
 from rocrate_validator import services
 from rocrate_validator.cli.commands.errors import handle_error
 from rocrate_validator.cli.main import cli
 from rocrate_validator.cli.ui.text.validate import ValidationCommandView
 from rocrate_validator.errors import ROCrateInvalidURIError
-from rocrate_validator.rocv_io.input import get_single_char, multiple_choice
-from rocrate_validator.rocv_io.output.console import Console
-from rocrate_validator.rocv_io.output.json import JSONOutputFormatter
-from rocrate_validator.rocv_io.output.text import TextOutputFormatter
-from rocrate_validator.rocv_io.output.text.layout.report import (
+from rocrate_validator.utils.io_helpers.input import get_single_char, multiple_choice
+from rocrate_validator.utils.io_helpers.output.console import Console
+from rocrate_validator.utils.io_helpers.output.json import JSONOutputFormatter
+from rocrate_validator.utils.io_helpers.output.text import TextOutputFormatter
+from rocrate_validator.utils.io_helpers.output.text.layout.report import (
     LiveTextProgressLayout, get_app_header_rule)
 from rocrate_validator.models import (Severity, ValidationResult,
                                       ValidationSettings)
-from rocrate_validator.utils import get_profiles_path, validate_rocrate_uri
+from rocrate_validator.utils.uri import validate_rocrate_uri
+from rocrate_validator.utils.paths import get_profiles_path
 
 # from rich.markdown import Markdown
 # from rich.table import Table

rocrate_validator/cli/main.py

@@ -16,11 +16,11 @@
 
 import rich_click as click
 
-import rocrate_validator.log as logging
+from rocrate_validator.utils import log as logging
 from rocrate_validator.cli.utils import running_in_jupyter
-from rocrate_validator.rocv_io.output.console import Console
-from rocrate_validator.rocv_io.output.pager import SystemPager
-from rocrate_validator.utils import get_version
+from rocrate_validator.utils.io_helpers.output.console import Console
+from rocrate_validator.utils.io_helpers.output.pager import SystemPager
+from rocrate_validator.utils.versioning import get_version
 
 # set up logging
 logger = logging.getLogger(__name__)

rocrate_validator/cli/ui/text/validate.py

@@ -16,11 +16,11 @@
 
 from typing import Any, Callable, Optional
 
-import rocrate_validator.log as logging
-from rocrate_validator.rocv_io.output.console import Console
-from rocrate_validator.rocv_io.output.pager import SystemPager
-from rocrate_validator.rocv_io.output.text import TextOutputFormatter
-from rocrate_validator.rocv_io.output.text.layout.report import ValidationReportLayout
+from rocrate_validator.utils import log as logging
+from rocrate_validator.utils.io_helpers.output.console import Console
+from rocrate_validator.utils.io_helpers.output.pager import SystemPager
+from rocrate_validator.utils.io_helpers.output.text import TextOutputFormatter
+from rocrate_validator.utils.io_helpers.output.text.layout.report import ValidationReportLayout
 from rocrate_validator.models import (ValidationResult, ValidationSettings,
                                       ValidationStatistics)
 

rocrate_validator/cli/utils.py

@@ -14,7 +14,7 @@
 
 import os
 
-import rocrate_validator.log as logging
+from rocrate_validator.utils import log as logging
 
 # set up logging
 logger = logging.getLogger(__name__)

rocrate_validator/config.py

@@ -19,7 +19,7 @@
 
 import enum_tools
 
-import rocrate_validator.log as logging
+from rocrate_validator.utils import log as logging
 
 # Set up logging
 logger = logging.getLogger(__name__)