doc: Update copyright/license info

Update the copyright years in the `LICENSE.md` file and add copyright
and license information to all source files (part of the Gold level
OpenSSF Best Practices).

LICENSE.md

@@ -1,29 +1,31 @@
-Modified BSD License
-====================
+# 3-Clause BSD License
 
-_Copyright © 2023, 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.  All rights reserved._
+_Copyright © 2023–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.
+All rights reserved._
 
 Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
+modification, are permitted provided that the following conditions are
+met:
 
 1. Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
 2. Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.
 3. Neither the name of Sandia National Laboratories nor the names of its
-   contributors may be used to endorse or promote products derived from this
-   software without specific prior written permission.
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS
+IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

example/basic.py

@@ -1,5 +1,10 @@
 #!/usr/bin/env python3
-"""Basic ``reverse_argparse`` functionality."""
+"""
+Basic ``reverse_argparse`` functionality.
+
+Copyright The reverse-argparse Authors.
+SPDX-License-Identifier: BSD-3-Clause
+"""
 from argparse import ArgumentParser
 
 from reverse_argparse import ReverseArgumentParser

example/default_values.py

@@ -1,5 +1,10 @@
 #!/usr/bin/env python3
-"""How ``reverse_argparse`` handles default values."""
+"""
+How ``reverse_argparse`` handles default values.
+
+Copyright The reverse-argparse Authors.
+SPDX-License-Identifier: BSD-3-Clause
+"""
 from argparse import ArgumentParser
 
 from reverse_argparse import ReverseArgumentParser

example/post_processing.py

@@ -1,5 +1,10 @@
 #!/usr/bin/env python3
-"""How ``reverse_argparse`` handles post-processing of arguments."""
+"""
+How ``reverse_argparse`` handles post-processing of arguments.
+
+Copyright The reverse-argparse Authors.
+SPDX-License-Identifier: BSD-3-Clause
+"""
 import os
 from argparse import ArgumentParser
 

example/pretty_printing.py

@@ -1,5 +1,10 @@
 #!/usr/bin/env python3
-"""``reverse_argparse`` pretty-printing functionality."""
+"""
+``reverse_argparse`` pretty-printing functionality.
+
+Copyright The reverse-argparse Authors.
+SPDX-License-Identifier: BSD-3-Clause
+"""
 import os
 from argparse import ArgumentParser
 

example/relative_references.py

@@ -1,5 +1,10 @@
 #!/usr/bin/env python3
-"""How ``reverse_argparse`` handles relative references."""
+"""
+How ``reverse_argparse`` handles relative references.
+
+Copyright The reverse-argparse Authors.
+SPDX-License-Identifier: BSD-3-Clause
+"""
 import os
 from argparse import ArgumentParser
 

example/subparsers.py

@@ -1,5 +1,10 @@
 #!/usr/bin/env python3
-"""How ``reverse_argparse`` handles subparsers."""
+"""
+How ``reverse_argparse`` handles subparsers.
+
+Copyright The reverse-argparse Authors.
+SPDX-License-Identifier: BSD-3-Clause
+"""
 import os
 from argparse import ArgumentParser
 

example/test_examples.py

@@ -1,5 +1,10 @@
 #!/usr/bin/env python3
-"""Run all the examples and ensure their output is correct."""
+"""
+Run all the examples and ensure their output is correct.
+
+Copyright The reverse-argparse Authors.
+SPDX-License-Identifier: BSD-3-Clause
+"""
 import re
 import shlex
 import subprocess  # nosec B404

reverse_argparse/__init__.py

@@ -3,6 +3,9 @@
 
 Provide the :class:`ReverseArgumentParser` class and
 :func:`quote_arg_if_necessary` helper function.
+
+Copyright The reverse-argparse Authors.
+SPDX-License-Identifier: BSD-3-Clause
 """
 
 from .reverse_argparse import ReverseArgumentParser, quote_arg_if_necessary

reverse_argparse/reverse_argparse.py

@@ -6,6 +6,9 @@
 that were already parsed via :mod:`argparse`, and the
 :func:`quote_arg_if_necessary` helper function to surround any arguments
 with spaces in them with quotes.
+
+Copyright The reverse-argparse Authors.
+SPDX-License-Identifier: BSD-3-Clause
 """
 
 import re

setup.py

@@ -3,6 +3,9 @@
 Setup file for the ``reverse_argparse`` package.
 
 To install, simply ``python3 -m pip install .`` in the repository root.
+
+Copyright The reverse-argparse Authors.
+SPDX-License-Identifier: BSD-3-Clause
 """
 import setuptools
 

test/__init__.py

@@ -4,4 +4,7 @@
 This ``__init__.py`` file creates the ``test`` package, such that tests
 can relative-import from modules in the sibling ``reverse_argparse``
 directory.
+
+Copyright The reverse-argparse Authors.
+SPDX-License-Identifier: BSD-3-Clause
 """

test/test_reverse_argparse.py

@@ -1,4 +1,10 @@
 #!/usr/bin/env python3
+"""
+The unit test suite for the ``reverse_argparse`` package.
+
+Copyright The reverse-argparse Authors.
+SPDX-License-Identifier: BSD-3-Clause
+"""
 
 import shlex
 import sys