Merge branch '31-change-file-naming-scheme' into 'master'

Change file naming scheme (#31)

Closes #31

See merge request ShellLogger/ShellLogger!24

doc/source/abstract_method.rst

@@ -0,0 +1,5 @@
+AbstractMethod
+==============
+
+.. autoexception:: shelllogger.abstract_method.AbstractMethod
+   :noindex:

doc/source/HTMLUtilities.rst → doc/source/html_utilities.rst

@@ -1,8 +1,8 @@
-HTMLUtilities
-=============
+HTML Utilities
+==============
 
 The following are a number of utility functions used to generate the HTML log
 file produced by :class:`ShellLogger`.
 
-.. automodule:: shelllogger.HTMLUtilities
+.. automodule:: shelllogger.html_utilities
    :noindex:

doc/source/index.rst

@@ -6,12 +6,12 @@ shelllogger
    :maxdepth: 3
    :caption: Contents
 
-   ShellLogger
-   Shell
-   AbstractMethod
-   StatsCollector
-   Trace
-   HTMLUtilities
+   shell_logger
+   shell
+   abstract_method
+   stats_collector
+   trace
+   html_utilities
    todo
 
 The ``shelllogger`` Python module allows you to interact with the shell, while
@@ -222,4 +222,5 @@ You can view the generated HTML log file `here
 More Details
 ------------
 
-For more detailed usage information, see the :doc:`ShellLogger`.
+For more detailed usage information, see the :doc:`shell_logger` class
+reference.

doc/source/shell.rst

@@ -0,0 +1,5 @@
+Shell
+=====
+
+.. automodule:: shelllogger.shell
+   :noindex:

doc/source/stats_collector.rst

@@ -0,0 +1,26 @@
+StatsCollector
+==============
+
+.. autoclass:: shelllogger.stats_collector.StatsCollector
+   :noindex:
+
+.. automethod:: shelllogger.stats_collector::stats_collectors
+   :noindex:
+
+DiskStatsCollector
+------------------
+
+.. autoclass:: shelllogger.stats_collector.DiskStatsCollector
+   :noindex:
+
+CPUStatsCollector
+-----------------
+
+.. autoclass:: shelllogger.stats_collector.CPUStatsCollector
+   :noindex:
+
+MemoryStatsCollector
+--------------------
+
+.. autoclass:: shelllogger.stats_collector.MemoryStatsCollector
+   :noindex:

doc/source/trace.rst

@@ -0,0 +1,20 @@
+Trace
+=====
+
+.. autoclass:: shelllogger.trace.Trace
+   :noindex:
+
+.. automethod:: shelllogger.trace::trace_collector
+   :noindex:
+
+STrace
+------
+
+.. autoclass:: shelllogger.trace.STrace
+   :noindex:
+
+LTrace
+------
+
+.. autoclass:: shelllogger.trace.LTrace
+   :noindex:

src/shelllogger/__init__.py

@@ -1,3 +1,3 @@
-from .ShellLogger import ShellLogger, ShellLoggerDecoder, ShellLoggerEncoder
+from .shell_logger import ShellLogger, ShellLoggerDecoder, ShellLoggerEncoder
 
 __all__ = ["ShellLogger", "ShellLoggerDecoder", "ShellLoggerEncoder"]

src/shelllogger/HTMLUtilities.py → src/shelllogger/html_utilities.py

@@ -192,8 +192,8 @@ def child_logger_card(log) -> Iterator[str]:
     Todo:
         * The type hinting for ``log`` is done in the docstring instead
           of the function signature, because to put it in the signature
-          would create a circular dependency between ``ShellLogger.py``
-          and ``HTMLUtilities.py``.  This function needs to be reworked
+          would create a circular dependency between ``shell_logger.py``
+          and ``html_utilities.py``.  This function needs to be reworked
           such that there's no longer a dependency on ``ShellLogger``.
     """
     child_html = log.to_html()

src/shelllogger/ShellLogger.py → src/shelllogger/shell_logger.py

@@ -1,13 +1,13 @@
 #!/usr/bin/env python3
 
 from __future__ import annotations
-from .Shell import Shell
-from .StatsCollector import stats_collectors
-from .Trace import trace_collector
-from .HTMLUtilities import (nested_simplenamespace_to_dict, opening_html_text,
-                            closing_html_text, append_html, html_message_card,
-                            message_card, command_card, child_logger_card,
-                            parent_logger_card_html)
+from .shell import Shell
+from .stats_collector import stats_collectors
+from .trace import trace_collector
+from .html_utilities import (nested_simplenamespace_to_dict, opening_html_text,
+                             closing_html_text, append_html, html_message_card,
+                             message_card, command_card, child_logger_card,
+                             parent_logger_card_html)
 from collections.abc import Iterable, Mapping
 from datetime import datetime, timedelta
 from typing import Iterator, List, Optional, Union

src/shelllogger/StatsCollector.py → src/shelllogger/stats_collector.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 
 from __future__ import annotations
-from .AbstractMethod import AbstractMethod
+from .abstract_method import AbstractMethod
 from abc import abstractmethod
 from multiprocessing import Process
 from multiprocessing.managers import SyncManager

src/shelllogger/Trace.py → src/shelllogger/trace.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 
 from __future__ import annotations
-from .AbstractMethod import AbstractMethod
+from .abstract_method import AbstractMethod
 from abc import abstractmethod
 from pathlib import Path