Add copyright/license info to all source files

doc/source/conf.py

@@ -20,7 +20,10 @@
 # -- Project information -----------------------------------------------------
 
 project = "ShellLogger"
-copyright = "2021, Sandia National Laboratories"
+copyright = (
+    "2024, National Technology & Engineering Solutions of Sandia, LLC "
+    "(NTESS)"
+)
 author = "Josh Braun, David Collins, Jason M. Gates"
 version = "1.0.0"
 release = version

examples/build_flex.py

@@ -1,4 +1,10 @@
 #!/usr/bin/env python3
+"""
+An example of cloning, configuring, building, and installing software.
+
+Copyright The shell-logger Authors.
+SPDX-License-Identifier: BSD-3-Clause
+"""
 
 from pathlib import Path
 from shelllogger import ShellLogger

examples/hello_world_html.py

@@ -1,4 +1,10 @@
 #!/usr/bin/env python3
+"""
+A simple example.
+
+Copyright The shell-logger Authors.
+SPDX-License-Identifier: BSD-3-Clause
+"""
 
 from pathlib import Path
 from shelllogger import ShellLogger

examples/hello_world_html_and_console.py

@@ -1,4 +1,10 @@
 #!/usr/bin/env python3
+"""
+A simple example, sending output to the log file and console.
+
+Copyright The shell-logger Authors.
+SPDX-License-Identifier: BSD-3-Clause
+"""
 
 from pathlib import Path
 from shelllogger import ShellLogger

examples/hello_world_html_with_stats.py

@@ -1,4 +1,10 @@
 #!/usr/bin/env python3
+"""
+A simple example, capturing various system statistics.
+
+Copyright The shell-logger Authors.
+SPDX-License-Identifier: BSD-3-Clause
+"""
 
 from pathlib import Path
 from shelllogger import ShellLogger

setup.py

@@ -1,4 +1,8 @@
 #!/usr/bin/env python3
+"""
+Copyright The shell-logger Authors.
+SPDX-License-Identifier: BSD-3-Clause
+"""
 import setuptools
 
 if __name__ == "__main__":

src/shelllogger/__init__.py

@@ -1,3 +1,9 @@
+"""
+The ``shell_logger`` package.
+
+Copyright The shell-logger Authors.
+SPDX-License-Identifier: BSD-3-Clause
+"""
 from .shell_logger import ShellLogger, ShellLoggerDecoder, ShellLoggerEncoder
 
 __all__ = ["ShellLogger", "ShellLoggerDecoder", "ShellLoggerEncoder"]

src/shelllogger/abstract_method.py

@@ -1,4 +1,10 @@
 #!/usr/bin/env python3
+"""
+Provides the :class:`AbstractMethod` exception.
+
+Copyright The shell-logger Authors.
+SPDX-License-Identifier: BSD-3-Clause
+"""
 
 import inspect
 

src/shelllogger/html_utilities.py

@@ -1,4 +1,10 @@
 #!/usr/bin/env python3
+"""
+Various utitlities for building the HTML log file.
+
+Copyright The shell-logger Authors.
+SPDX-License-Identifier: BSD-3-Clause
+"""
 from collections.abc import Iterable, Mapping
 from datetime import datetime
 import pkgutil

src/shelllogger/shell.py

@@ -1,4 +1,10 @@
 #!/usr/bin/env python3
+"""
+Provides the :class:`Shell` class.
+
+Copyright The shell-logger Authors.
+SPDX-License-Identifier: BSD-3-Clause
+"""
 
 from __future__ import annotations
 import fcntl

src/shelllogger/shell_logger.py

@@ -1,4 +1,10 @@
 #!/usr/bin/env python3
+"""
+Provides the :class:`ShellLogger` class, along with some helpers.
+
+Copyright The shell-logger Authors.
+SPDX-License-Identifier: BSD-3-Clause
+"""
 
 from __future__ import annotations
 from .shell import Shell

src/shelllogger/stats_collector.py

@@ -1,4 +1,10 @@
 #!/usr/bin/env python3
+"""
+Provides the various means of collecting machine statistics.
+
+Copyright The shell-logger Authors.
+SPDX-License-Identifier: BSD-3-Clause
+"""
 
 from __future__ import annotations
 from .abstract_method import AbstractMethod

src/shelllogger/trace.py

@@ -1,4 +1,10 @@
 #!/usr/bin/env python3
+"""
+Provides the means of collecting various trace data.
+
+Copyright The shell-logger Authors.
+SPDX-License-Identifier: BSD-3-Clause
+"""
 
 from __future__ import annotations
 from .abstract_method import AbstractMethod

tests/test_shell_logger.py

@@ -1,3 +1,9 @@
+"""
+The unit test suite for the ``shell_logger`` package.
+
+Copyright The shell-logger Authors.
+SPDX-License-Identifier: BSD-3-Clause
+"""
 from _pytest.capture import CaptureFixture
 from _pytest.monkeypatch import MonkeyPatch
 from inspect import stack