Use setuptools and provide README to python binding for PyPI hosting.

syoyo · syoyo · commit b3ca787193cf · 2019-05-17T17:42:21.000+09:00
diff --git a/python/LICENSE b/python/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2012-2019 Syoyo Fujita and many contributors.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+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 AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/python/README.md b/python/README.md
@@ -0,0 +1,61 @@
+# tinyobj, Wavefront .obj loader
+
+tinyobj is a python wrapper for C++ wavefront .obj loader.
+tinyobj is rather fast and feature rich than other pure python version of .obj loader.
+
+## Quick tutorial
+
+```py
+import sys
+import tinyobj
+
+# Create reader.
+reader = tinyobj.ObjReader()
+
+filename = "cornellbox.obj"
+
+# Load .obj(and .mtl) using default configuration
+ret = reader.ParseFromFile(filename)
+
+if ret == False:
+    print("Warn:", reader.Warning())
+    pint("Err:", reader.Error())
+    print("Failed to load : ", filename)
+
+    sys.exit(-1)
+
+if reader.Warning():
+    print("Warn:", reader.Warning())
+
+attrib = reader.GetAttrib()
+print("attrib.vertices = ", len(attrib.vertices))
+print("attrib.normals = ", len(attrib.normals))
+print("attrib.texcoords = ", len(attrib.texcoords))
+
+materials = reader.GetMaterials()
+print("Num materials: ", len(materials))
+for m in materials:
+    print(m.name)
+    print(m.diffuse)
+
+shapes = reader.GetShapes()
+print("Num shapes: ", len(shapes))
+for shape in shapes:
+    print(shape.name)
+    print("num_indices = {}".format(len(shape.mesh.indices)))
+
+```
+
+## More detailed usage
+
+Please take a look at `python/sample.py` file in tinyobjloader git repo.
+
+https://github.com/syoyo/tinyobjloader/blob/master/python/sample.py
+
+## License
+
+MIT license.
+
+## TODO
+ * [ ] Writer saver
+
diff --git a/python/sample.py b/python/sample.py
@@ -16,10 +16,12 @@
 
 if ret == False:
     print("Failed to load : ", filename)
+    print("Warn:", reader.Warning())
+    print("Err:", reader.Error())
     sys.exit(-1)
 
-print("Warn:", reader.Warning())
-print("Err:", reader.Error())
+if reader.Warning():
+    print("Warn:", reader.Warning())
 
 attrib = reader.GetAttrib()
 print("attrib.vertices = ", len(attrib.vertices))
diff --git a/python/setup.py b/python/setup.py
@@ -1,17 +1,28 @@
-from distutils.core import setup, Extension
+import setuptools
 
+with open("README.md", "r") as fh:
+    long_description= fh.read()
 
 # `tiny_obj_loader.cc` contains implementation of tiny_obj_loader.
-m = Extension('tinyobj',
+m = setuptools.Extension('tinyobj',
               sources = ['bindings.cc', 'tiny_obj_loader.cc'],
               extra_compile_args=['-std=c++11'],
               include_dirs = ['../', '../pybind11/include']
               )
 
 
-setup (name = 'tinyobj',
+setuptools.setup (name = 'tinyobj',
        version = '0.1',
        description = 'Python module for tinyobjloader',
+       long_description = long_description,
+       long_description_content_type = "text/markdown",
+       author="Syoyo Fujita",
+       author_email="syoyo@lighttransport.com",
+       url="https://github.com/syoyo/tinyobjloader",
+       classifiers=[
+           "License :: OSI Approved :: MIT License",
+       ],
+       packages=setuptools.find_packages(),
        ext_modules = [m])
 
 
