Improvements to setup.py (#78)

* Define PY_SSIZE_T_CLEAN
* Add classifiers
* Add __version__ module attribute
* Add src to includes to allow package-absolute includes
* Fix typo LD_PREALOAD and correct description

Author: Flamefire

CMakeLists.txt

@@ -13,6 +13,9 @@ find_package(Python REQUIRED COMPONENTS Interpreter Development)
 Python_add_library(scorep_bindings src/scorep.cpp)
 target_link_libraries(scorep_bindings PRIVATE Scorep::Scorep)
 target_compile_features(scorep_bindings PRIVATE cxx_std_11)
+target_compile_definitions(scorep_bindings PRIVATE PY_SSIZE_T_CLEAN)
+target_include_directories(scorep_bindings PRIVATE src)
+
 set_target_properties(scorep_bindings PROPERTIES
   LIBRARY_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/site-packages/scorep
 )

scorep/__init__.py

@@ -1 +1,2 @@
-__all__ = ["user", "instrumenter"]
+__all__ = ["user", "instrumenter", "__version__"]
+from scorep._version import __version__

scorep/_version.py

@@ -0,0 +1 @@
+__version__ = "3.0"

setup.py

@@ -1,3 +1,4 @@
+import os
 from distutils.core import setup, Extension
 import scorep.helper
 
@@ -20,25 +21,45 @@
 
 cmodules = []
 (include, _, _, _, _) = scorep.helper.generate_compile_deps()
+src_folder = os.path.abspath('src')
+include += [src_folder]
 cmodules.append(Extension('scorep.scorep_bindings',
                           include_dirs=include,
-                          libraries=[],
+                          define_macros=[('PY_SSIZE_T_CLEAN', '1')],
                           extra_compile_args=["-std=c++11"],
                           sources=['src/scorep.cpp']))
 
 setup(
     name='scorep',
-    version='3.0',
+    version=scorep._version.__version__,
     description='This is a scorep tracing package for python',
     author='Andreas Gocht',
     author_email='andreas.gocht@tu-dresden.de',
     url='https://github.com/score-p/scorep_binding_python',
     long_description='''
 This package allows tracing of python code using Score-P.
 A working Score-P version is required.
-For MPI tracing it uses LD_PREALOAD.
+To enable tracing it uses LD_PRELOAD to load the Score-P runtime libraries.
 Besides this, it uses the traditional python-tracing infrastructure.
 ''',
     packages=['scorep', 'scorep.instrumenters'],
-    ext_modules=cmodules
+    ext_modules=cmodules,
+    classifiers=[
+        'Development Status :: 4 - Beta',
+        'Environment :: Console',
+        'Intended Audience :: Developers',
+        'Topic :: Software Development :: Testing',
+        'Topic :: Software Development :: Quality Assurance',
+        'Programming Language :: Python :: 2',
+        'Programming Language :: Python :: 2.7',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.4',
+        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: Implementation :: CPython',
+        'Operating System :: POSIX',
+        'Operating System :: Unix',
+    ],
 )

test/test.py

@@ -60,6 +60,10 @@ def setUp(self):
             ignore_errors=True)
         os.mkdir(self.env["SCOREP_EXPERIMENT_DIRECTORY"])
 
+    def test_has_version(self):
+        import scorep
+        self.assertIsNotNone(scorep.__version__)
+
     def test_user_regions(self):
         env = self.env
         env["SCOREP_EXPERIMENT_DIRECTORY"] += "/test_user_regions"