Python K4A: Rearranging directory tree so that it matches the expecta…

…tion of what gets imported when users use "import k4a". Adding a powershell script to build a wheel file. Adding empty docs files.
microsoft · jaygullapalli · Mar 24, 2021 · Dec 9, 2020 · Dec 9, 2020 · Dec 9, 2020
commit f1e90ba9739ddcbcc9fb68b79523c4d15e6f0068
diff --git a/src/python/k4a/docs/PLACEHOLDER.md → src/python/k4a/README.md b/src/python/k4a/docs/PLACEHOLDER.md → src/python/k4a/README.md
@@ -1,19 +1,15 @@
-# Azure Kinect SDK (K4A)
+# Azure Kinect Python API(K4A)
 
-Welcome to the Azure Kinect Sensor SDK! We hope you can use it to build many great applications and participate in the project. Don't be shy to ask questions, and provide feedback. See [Azure.com/Kinect](https://Azure.com/kinect) for device
+Welcome to the Azure Kinect Python API! We hope you can use it to build many great applications and participate in the project. Don't be shy to ask questions, and provide feedback. See [Azure.com/Kinect](https://Azure.com/kinect) for device
 info and available documentation.
 
-[![Build Status
-(develop)](https://dev.azure.com/ms/Azure-Kinect-Sensor-SDK/_apis/build/status/Microsoft.Azure-Kinect-Sensor-SDK%20(Public)?branchName=develop)](https://dev.azure.com/ms/Azure-Kinect-Sensor-SDK/_build/latest?definitionId=133&branchName=develop)
-[![Nuget](https://img.shields.io/nuget/vpre/Microsoft.Azure.Kinect.Sensor.svg)](https://www.nuget.org/packages/Microsoft.Azure.Kinect.Sensor/)
-
 ## Introduction
 
-**Azure Kinect SDK** is a cross platform (Linux and Windows) user mode SDK to read data from your Azure Kinect device.
+**K4A** is a Python user mode API to read data from your Azure Kinect device.
 
-## Why use the Azure Kinect SDK
+## Why use K4A
 
-The Azure Kinect SDK enables you to get the most out of your Azure Kinect camera. Features include:
+K4A enables you to get the most out of your Azure Kinect camera. Features include:
 
 * Depth camera access
 * RGB camera access and control (e.g. exposure and white balance)
@@ -23,30 +19,30 @@ The Azure Kinect SDK enables you to get the most out of your Azure Kinect camera
 * Camera frame meta-data access for image resolution, timestamp and temperature
 * Device calibration data access
 
+All image data is encapsulated in numpy arrays, allowing Python users to easily use the data in OpenCV
+and other packages that work with numpy arrays.
+
 ## Installation
 
-To use the SDK, please refer to the installation instructions in [usage](docs/usage.md)
+To use the Python API, please refer to the installation instructions in [usage](docs/usage.md)
 
 ## Documentation
 
-API documentation is avaliable [here](https://microsoft.github.io/Azure-Kinect-Sensor-SDK/).
+API documentation is available [here]().
 
 ## Building
 
-Azure Kinect SDK uses CMake to build. For instructions on how to build this SDK please see
+K4A uses Python's setuptools to build a wheel file for distribution. 
+For instructions on how to build this distributable, please see
 [building](docs/building.md).
 
-## Versioning
-
-The Azure Kinect SDK uses semantic versioning, please see [versioning.md](docs/versioning.md) for more information.
-
 ## Testing
 
 For information on writing or running tests, please see [testing.md](docs/testing.md)
 
 ## Contribute
 
-We welcome your contributions! Please see the [contribution guidelines](CONTRIBUTING.md).
+We welcome your contributions! Please see the [contribution guidelines](../../../CONTRIBUTING.md).
 
 ## Feedback
 
@@ -56,8 +52,7 @@ For SDK feedback or to report a bug, please file a [GitHub Issue](https://github
 
 There are several places where the sample code can be found.
 
-- In this repository: [Azure-Kinect-Sensor-SDK\examples](https://github.com/microsoft/Azure-Kinect-Sensor-SDK/tree/develop/examples)- each example has a readme page that describes it and the steps to set it up.
-- [Azure-Kinect-Samples](https://github.com/microsoft/Azure-Kinect-Samples) repository. There are multiple examples of how to use both Sensor and Body tracking SDKs.
+- In this repository: [K4A\examples](examples)- each example has a readme page that describes it and the steps to set it up.
 
 ## Q&A
 
@@ -83,6 +78,6 @@ email to ensure we received your original message. Further information, includin
 
 ## License and Microsoft Support for Azure Kinect Sensor SDK
 
-[MIT License](LICENSE)
+[MIT License](../../../LICENSE)
 
-[Microsoft Support for Azure Kinect Sensor SDK](microsoft-support.md)
+[Microsoft Support for Azure Kinect Sensor SDK](../../../microsoft-support.md)
diff --git a/src/python/k4a/__init__.py b/src/python/k4a/__init__.py
diff --git a/src/python/k4a/_bindings/_k4atypes.py b/src/python/k4a/_bindings/_k4atypes.py
diff --git a/src/python/k4a/api/__init__.py b/src/python/k4a/api/__init__.py
diff --git a/src/python/k4a/build_wheel.ps1 b/src/python/k4a/build_wheel.ps1
@@ -0,0 +1,28 @@
+# Create a virtual environment and activate it.
+python -m venv temp_build_venv
+./temp_build_venv/Scripts/activate
+
+# Install the package in editable mode so that it installs dependencies. These are needed for sphinx docs.
+python -m pip install --upgrade pip
+pip install -e .
+
+
+# Build the .whl file and place it in a build/ folder.
+pip install wheel
+pip wheel . -w build
+Remove-Item ./build/* -Exclude k4a*.whl -Recurse -Force
+
+
+# Build the docs and move them to the build/ folder.
+#cd ./docs
+#powershell -File ./build_docs.ps1
+#Move-Item ./build/html ../build/docs/
+
+
+# Deactivate virtual environment and delete it.
+./temp_build_venv/Scripts/deactivate.bat
+Remove-Item -LiteralPath "temp_build_venv" -Force -Recurse
+
+
+# Copy the docs/ folder into the build/ folder.
+#Copy-Item -Path .\docs -Destination .\build -Recurse
diff --git a/src/python/k4a/_bindings/_k4a.py → src/python/k4a/docs/building.md b/src/python/k4a/_bindings/_k4a.py → src/python/k4a/docs/building.md
diff --git a/src/python/k4a/docs/testing.md b/src/python/k4a/docs/testing.md
diff --git a/src/python/k4a/README_PLACEHOLDER.md → src/python/k4a/docs/usage.md b/src/python/k4a/README_PLACEHOLDER.md → src/python/k4a/docs/usage.md
diff --git a/src/python/k4a/setup.py b/src/python/k4a/setup.py
@@ -7,23 +7,16 @@
     author_email='[email protected]',
     description='Python interface to Azure Kinect API.',
     keywords=['k4a', 'Azure Kinect', 'Kinect for Azure'],
-    url='',
+    url='https://github.com/JonathanESantos/Azure-Kinect-Sensor-SDK/tree/python_ctypes_bindings',
     license='Copyright (C) Microsoft Corporation. All rights reserved.',
     python_requires='>=3.6',
-    packages=find_packages(exclude=['docs', 'data']),
-    extras_require={
-        'dev': [
-        ],
-    },
+    packages=find_packages('src'),
+    package_dir={'': 'src'},
+    package_data={"k4a":["_libs/*"]},
     zip_safe=False,
     tests_require=[
         'pytest',
     ],
-    package_data={
-        'k4a': [
-                '_lib/*',
-        ]
-    },
     install_requires=[
     ],
 )
diff --git a/src/python/k4a/src/k4a/__init__.py b/src/python/k4a/src/k4a/__init__.py
@@ -0,0 +1 @@
+from .k4atypes import * 
diff --git a/src/python/k4a/_bindings/__init__.py → src/python/k4a/src/k4a/_bindings/__init__.py b/src/python/k4a/_bindings/__init__.py → src/python/k4a/src/k4a/_bindings/__init__.py
diff --git a/src/python/k4a/src/k4a/_bindings/_k4a.py b/src/python/k4a/src/k4a/_bindings/_k4a.py
diff --git a/src/python/k4a/src/k4a/_bindings/_k4atypes.py b/src/python/k4a/src/k4a/_bindings/_k4atypes.py
@@ -0,0 +1,21 @@
+'''k4atyps.py
+
+Defines Python ctypes equivalent structures to those defined in k4atypes.h. 
+
+Credit given to hexops's github contribution for the
+ctypes.Structure definitions and ctypes function bindings.
+https://github.com/hexops/Azure-Kinect-Python
+'''
+
+# Add top-level k4a directory to path.
+import sys
+import os
+
+k4a_top_level = os.path.dirname(os.path.dirname(__file__))
+sys.path.insert(0, k4a_top_level)
+
+import ctypes
+import struct
+
+import k4a
+
diff --git a/src/python/k4a/_libs/README.md → src/python/k4a/src/k4a/_libs/README.md b/src/python/k4a/_libs/README.md → src/python/k4a/src/k4a/_libs/README.md
diff --git a/src/python/k4a/api/k4atypes.py → src/python/k4a/src/k4a/k4atypes.py b/src/python/k4a/api/k4atypes.py → src/python/k4a/src/k4a/k4atypes.py
diff --git a/src/python/k4a/tests/__init__.py b/src/python/k4a/tests/__init__.py
diff --git a/src/python/k4a/tests/test_k4atypes.py b/src/python/k4a/tests/test_k4atypes.py
@@ -4,11 +4,6 @@
 '''
 
 import unittest
-
-# Add top-level k4a directory to path.
-import sys
-import os
-sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.dirname(__file__))))
 
 import k4a
 
@@ -145,7 +140,4 @@ def test_k4a_firmware_signature_t(self):
             self.assertEqual(e.value, next(enum_values))
 
 if __name__ == '__main__':
-
-
-
     unittest.main()