Fix license issues (#38)

We copy the approach of Scipy to licensing our own code and the bundled code.

Author: HDembinski

.gitignore

@@ -1,3 +1,4 @@
+MANIFEST
 .DS_Store
 var
 build

CMakeLists.txt

@@ -24,9 +24,11 @@ else()
 endif()
 
 file(GLOB SOURCES "src/*.cpp")
-file(GLOB SOURCES2 "extern/HepMC3/src/*.cc")
+file(GLOB HEPMC3_SOURCES "extern/HepMC3/src/*.cc")
 
-pybind11_add_module(_core MODULE ${SOURCES} ${SOURCES2})
+# pyhepmc falls under Section 5 "Combined Libraries" of the LGPL-v3. Since we
+# satisfy a) and b), we do not need to compile the code into a separate library.
+pybind11_add_module(_core MODULE ${SOURCES} ${HEPMC3_SOURCES})
 target_include_directories(_core PRIVATE extern/cpp-member-accessor/include)
 target_include_directories(_core PRIVATE extern/mp11/include)
 target_include_directories(_core PRIVATE extern/HepMC3/include)
@@ -36,8 +38,5 @@ if(MSVC)
   target_compile_options(_core PRIVATE /bigobj)
   set(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS ON)
 else()
-  target_compile_options(_core PRIVATE -fvisibility=hidden -Wall
-                                       -Wno-self-assign-overloaded)
+  target_compile_options(_core PRIVATE -Wall -Wno-self-assign-overloaded)
 endif()
-set_target_properties(_core PROPERTIES VISIBILITY_INLINES_HIDDEN ON)
-target_compile_definitions(_core PRIVATE HEPMC3_HEPEVT_NMXHEP=10000)

LICENSE

@@ -1,6 +1,3 @@
-HepMC3 code in path src/HepMC3 is distributed under GPL-v3, see
-src/HepMC3/LICENCE. The rest of the code is covered by the following license:
-
 BSD 3-Clause License
 
 Copyright (c) 2018, Hans Dembinski

LICENSES_bundled

@@ -0,0 +1,69 @@
+The pyhepmc repository and source distributions bundle a number of libraries that
+are compatibly licensed.  We list these here.
+
+Name: HepMC3
+Files: extern/HepMC3/*
+License: LGPL-v3
+  For details, see extern/HepMC3/LICENCE and extern/HepMC3/COPYING.
+
+Name: pybind11
+Files: extern/pybind11/*
+License:
+  Copyright (c) 2016 Wenzel Jakob <[email protected]>, All rights reserved.
+
+  Redistribution and use in source and binary forms, with or without
+  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 the copyright holder nor the names of its 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.
+
+Name: cpp-member-accessor
+Files: extern/cpp-member-accessor/*
+License: MIT
+  For details, see extern/cpp-member-accessor/LICENSE
+
+Name: Boost Mp11
+Files: extern/mp11/*
+License:
+  Boost Software License - Version 1.0 - August 17th, 2003
+
+  Permission is hereby granted, free of charge, to any person or organization
+  obtaining a copy of the software and accompanying documentation covered by
+  this license (the "Software") to use, reproduce, display, distribute,
+  execute, and transmit the Software, and to prepare derivative works of the
+  Software, and to permit third-parties to whom the Software is furnished to
+  do so, all subject to the following:
+
+  The copyright notices in the Software and this entire statement, including
+  the above license grant, this restriction and the following disclaimer,
+  must be included in all copies of the Software, in whole or in part, and
+  all derivative works of the Software, unless such copies or derivative
+  works are solely in the form of machine-executable object code generated by
+  a source language processor.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
+  SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
+  FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
+  ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+  DEALINGS IN THE SOFTWARE.

MANIFEST.in

@@ -1,20 +1,20 @@
-include src/*.cpp
-include src/*.hpp
-include src/pyhepmc/*.py
 recursive-include extern/HepMC3/include *.h
 recursive-include extern/HepMC3/src *.cc
+include extern/HepMC3/LICENCE
+include extern/HepMC3/COPYING
 recursive-include extern/pybind11/include *.h
-recursive-include extern/cpp-member-accessor/include *.hpp
-recursive-include extern/mp11/include *.hpp
 include extern/pybind11/CMakeLists.txt
 include extern/pybind11/tools/*.cmake
-include extern/pybind11/LICENSE
-include extern/HepMC3/LICENCE
-include extern/cpp-member-accessor/LICENSE
+recursive-include extern/cpp-member-accessor/include *.hpp
+recursive-include extern/mp11/include *.hpp
+include src/*.cpp
+include src/*.hpp
+include src/pyhepmc/*.py
 include cmake_ext.py
 include CMakeLists.txt
 include LICENSE
 include pyproject.toml
 include README.rst
 include setup.cfg
 include setup.py
+include setup_utils.py

README.rst

@@ -1,7 +1,7 @@
 pyhepmc
 =======
 
-A Pythonic wrapper for the HepMC3 C++ library.
+A Pythonic wrapper for the `HepMC3 C++ library <http://hepmc.web.cern.ch/hepmc>`_.
 
 .. image:: https://scikit-hep.org/assets/images/Scikit--HEP-Project-blue.svg
   :target: https://scikit-hep.org
@@ -27,15 +27,7 @@ However, building from source is also easy. External software is not required. J
 
 **pyhepmc is Pythonic and Jupyter notebook-friendly**
 
-pyhepmc is a hand-crafted mapping of C++ code to Python, see documentation for details. Python idioms are supported where appropriate. The classes are designed to render well in Jupyter notebooks.
-
-- C++ methods which act like properties are represented as properties,
-  e.g. ``GenParticle::set_status`` and ``GenParticle::status`` are mapped to a single
-  ``GenParticle.status`` field in Python.
-- Tuples and lists are implicitly convertible to ``FourVector`` and ``ToolInfo`` objects.
-- Vectors of objects on the C++ side are mapped to Python lists.
-- ``Reader`` and ``Writer`` classes support the context manager protocol. ``Reader`` objects can be iterated over.
-- A convenient ``open`` function is provided for reading and writing HepMC files.
+pyhepmc is a hand-crafted mapping of C++ code to Python, see documentation for details. Python idioms are supported where appropriate. The classes are designed to render well in Jupyter notebooks. IO is simplified. Events can be visualized in Jupyter notebooks.
 
 **pyhepmc supports visualizations powered by graphviz**
 
@@ -45,7 +37,7 @@ pyhepmc can optionally visualize events, using the mature `graphviz <https://gra
 
 **pyhepmc is actively maintained**
 
-pyhepmc is part of the Scikit-HEP project, which aims to provide all tools needed by particle physicists to do data analysis in Python. There is also official collaboration with the HepMC3 project.
+pyhepmc is part of the Scikit-HEP project, which aims to provide all tools needed by particle physicists to do data analysis in Python. It is developed in close collaboration with the HepMC3 project.
 
 **pyhepmc is thoroughly unit tested**
 
@@ -54,9 +46,9 @@ We have 100% coverage for the Python API.
 Documentation
 -------------
 
-pyhepmc mirrors the C++ interface of the `HepMC3 library, which is documented here <http://hepmc.web.cern.ch/hepmc>`_. The documentation is mostly copied from HepMC3 and available as Python docstrings, so you can use Python's ``help()`` browser to learn about the API. Alternatively, you can consult our online reference generated from these docstrings.
+pyhepmc largely mirrors the C++ interface of the `HepMC3 library, which is documented here <http://hepmc.web.cern.ch/hepmc>`_. Parts of the documentation have been copied from HepMC3. Documentation is available as Python docstrings, so you can use Python's ``help()`` browser to learn about the API. Alternatively, you can consult `the online reference generated from these docstrings <https://scikit-hep.org/pyhepmc/>`_ which includes some examples.
 
 License
 -------
 
-pyhepmc is covered by the BSD 3-clause license, see the ``LICENSE`` file for details. This license only applies to the pyhepmc code. The connected external libraries HepMC3 and pybind11 are covered by other licenses, as described in their respective ``LICENSE`` files.
+The pyhepmc code is covered by the BSD 3-clause license, but its main functionality comes from bundled software which is released under different licenses. The HepMC3 library is licensed under LGPL-v3 and bundles other software which is released under different licenses. See the files ``LICENSE`` and ``LICENSE_bundled`` in the source directory for details.

setup.cfg

@@ -2,21 +2,23 @@
 name = pyhepmc
 author = Hans Dembinski
 author_email = [email protected]
-description = Pythonic interface to the HepMC3 C++ library.
+description = Pythonic interface to the HepMC3 C++ library licensed under LGPL-v3.
 long_description = file: README.rst
 long_description_content_type = text/x-rst
 url = https://github.com/scikit-hep/pyhepmc
 project_urls =
     Documentation = https://scikit-hep.org/pyhepmc/
-license_files = LICENSE, extern/pybind11/LICENSE, extern/HepMC3/LICENSE
+license = BSD 3-Clause
+license_files =
+    LICENSE
 classifiers =
-    Programming Language :: Python :: 3
+    Development Status :: 5 - Production
     License :: OSI Approved :: BSD License
-    Operating System :: OS Independent
-    Development Status :: 4 - Beta
+    Programming Language :: Python :: 3
     Operating System :: MacOS
     Operating System :: POSIX
     Operating System :: Unix
+    Operating System :: Windows
     Topic :: Scientific/Engineering
     Intended Audience :: Developers
 

setup.py

@@ -1,16 +1,25 @@
+import sys
 from pathlib import Path
 from setuptools import setup
-import sys
+from distutils.command.sdist import sdist
 
 cdir = Path(__file__).parent.absolute()
 
 sys.path.append(str(cdir))
 from cmake_ext import CMakeExtension, CMakeBuild  # noqa: E402
+from setup_utils import merge_license_files  # noqa: E402
+
+
+class sdist_mod(sdist):
+    def run(self):
+        with merge_license_files():
+            sdist.run(self)
+
 
 setup(
     zip_safe=False,
     use_scm_version=True,
     setup_requires=["setuptools_scm"],
     ext_modules=[CMakeExtension("pyhepmc._core")],
-    cmdclass={"build_ext": CMakeBuild},
+    cmdclass={"build_ext": CMakeBuild, "sdist": sdist_mod},
 )

setup_utils.py

@@ -0,0 +1,28 @@
+from contextlib import contextmanager
+
+
+@contextmanager
+def merge_license_files():
+    """
+    Merge LICENSE.txt and LICENSES_bundled.txt for sdist creation.
+
+    This follows the approach of Scipy and is to keep LICENSE in repo as an
+    exact BSD 3-clause, to make GitHub state correctly how pyhepmc is licensed.
+    """
+
+    l1 = "LICENSE"
+    l2 = "LICENSES_bundled"
+
+    with open(l1, "r") as f:
+        content1 = f.read()
+
+    with open(l2, "r") as f:
+        content2 = f.read()
+
+    with open(l1, "w") as f:
+        f.write(content1 + "\n\n" + content2)
+
+    yield
+
+    with open(l1, "w") as f:
+        f.write(content1)