Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update copyright text in source files #10

Merged
merged 1 commit into from
Feb 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion example/build_flex.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@
"""
An example of cloning, configuring, building, and installing software.

Copyright The shell-logger Authors.
© 2024 National Technology & Engineering Solutions of Sandia, LLC
(NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the U.S.
Government retains certain rights in this software.

SPDX-License-Identifier: BSD-3-Clause
"""
from pathlib import Path
Expand Down
5 changes: 4 additions & 1 deletion example/hello_world_html.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@
"""
A simple example.

Copyright The shell-logger Authors.
© 2024 National Technology & Engineering Solutions of Sandia, LLC
(NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the U.S.
Government retains certain rights in this software.

SPDX-License-Identifier: BSD-3-Clause
"""
from pathlib import Path
Expand Down
5 changes: 4 additions & 1 deletion example/hello_world_html_and_console.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@
"""
A simple example, sending output to the log file and console.

Copyright The shell-logger Authors.
© 2024 National Technology & Engineering Solutions of Sandia, LLC
(NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the U.S.
Government retains certain rights in this software.

SPDX-License-Identifier: BSD-3-Clause
"""
from pathlib import Path
Expand Down
5 changes: 4 additions & 1 deletion example/hello_world_html_with_stats.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@
"""
A simple example, capturing various system statistics.

Copyright The shell-logger Authors.
© 2024 National Technology & Engineering Solutions of Sandia, LLC
(NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the U.S.
Government retains certain rights in this software.

SPDX-License-Identifier: BSD-3-Clause
"""
from pathlib import Path
Expand Down
9 changes: 8 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
#!/usr/bin/env python3
"""
Copyright The shell-logger Authors.
Setup file for the ``shell-logger`` package.

To install, simply ``python3 -m pip install .`` in the repository root.

© 2024 National Technology & Engineering Solutions of Sandia, LLC
(NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the U.S.
Government retains certain rights in this software.

SPDX-License-Identifier: BSD-3-Clause
"""
import setuptools
Expand Down
5 changes: 4 additions & 1 deletion shell_logger/__init__.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
"""
The ``shell_logger`` package.

Copyright The shell-logger Authors.
© 2024 National Technology & Engineering Solutions of Sandia, LLC
(NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the U.S.
Government retains certain rights in this software.

SPDX-License-Identifier: BSD-3-Clause
"""
from .shell_logger import ShellLogger, ShellLoggerDecoder, ShellLoggerEncoder
Expand Down
5 changes: 4 additions & 1 deletion shell_logger/abstract_method.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@
"""
Provides the :class:`AbstractMethod` exception.

Copyright The shell-logger Authors.
© 2024 National Technology & Engineering Solutions of Sandia, LLC
(NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the U.S.
Government retains certain rights in this software.

SPDX-License-Identifier: BSD-3-Clause
"""
import inspect
Expand Down
5 changes: 4 additions & 1 deletion shell_logger/html_utilities.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@
"""
Various utitlities for building the HTML log file.

Copyright The shell-logger Authors.
© 2024 National Technology & Engineering Solutions of Sandia, LLC
(NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the U.S.
Government retains certain rights in this software.

SPDX-License-Identifier: BSD-3-Clause
"""
from collections.abc import Iterable, Mapping
Expand Down
5 changes: 4 additions & 1 deletion shell_logger/shell.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@
"""
Provides the :class:`Shell` class.

Copyright The shell-logger Authors.
© 2024 National Technology & Engineering Solutions of Sandia, LLC
(NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the U.S.
Government retains certain rights in this software.

SPDX-License-Identifier: BSD-3-Clause
"""
from __future__ import annotations
Expand Down
5 changes: 4 additions & 1 deletion shell_logger/shell_logger.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@
"""
Provides the :class:`ShellLogger` class, along with some helpers.

Copyright The shell-logger Authors.
© 2024 National Technology & Engineering Solutions of Sandia, LLC
(NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the U.S.
Government retains certain rights in this software.

SPDX-License-Identifier: BSD-3-Clause
"""
from __future__ import annotations
Expand Down
5 changes: 4 additions & 1 deletion shell_logger/stats_collector.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@
"""
Provides the various means of collecting machine statistics.

Copyright The shell-logger Authors.
© 2024 National Technology & Engineering Solutions of Sandia, LLC
(NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the U.S.
Government retains certain rights in this software.

SPDX-License-Identifier: BSD-3-Clause
"""
from __future__ import annotations
Expand Down
5 changes: 4 additions & 1 deletion shell_logger/trace.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@
"""
Provides the means of collecting various trace data.

Copyright The shell-logger Authors.
© 2024 National Technology & Engineering Solutions of Sandia, LLC
(NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the U.S.
Government retains certain rights in this software.

SPDX-License-Identifier: BSD-3-Clause
"""
from __future__ import annotations
Expand Down
5 changes: 4 additions & 1 deletion test/test_shell_logger.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
"""
The unit test suite for the ``shell_logger`` package.

Copyright The shell-logger Authors.
© 2024 National Technology & Engineering Solutions of Sandia, LLC
(NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the U.S.
Government retains certain rights in this software.

SPDX-License-Identifier: BSD-3-Clause
"""
from _pytest.capture import CaptureFixture
Expand Down
Loading