Merge pull request #1 from enhanced-telerobotics/pip_dev

Support pip and ready for publish

README.md

@@ -0,0 +1,56 @@
+# pyMT4
+
+`pyMT4` provides basic functions to interact with the MicronTracker 4 library using a more Python-friendly approach. This package serves as a bridge between Python and the MicronTracker 4 C++ library, making it easier to integrate MicronTracker functionalities into Python projects.
+
+## Getting Started
+
+### Requirements
+
+- This package requires the dynamic library from the MicronTracker 4 official installation.
+- The default library path is determined based on the registry key settings. 
+- Currently, the package supports Windows only.
+
+### Installation
+
+You can install `pyMT4` directly from the GitHub repository using pip:
+
+```bash
+pip install git+https://github.com/enhanced-telerobotics/pyMT4.git
+```
+
+Alternatively, you can install it locally in editable mode by navigating to the directory containing `pyMT4` and running:
+
+```bash
+cd /path/to/pyMT4
+pip install -e .
+```
+
+### Usage
+
+To use the `pyMT4` package, simply import the `MTC` class from the package:
+
+```python
+from pyMT4 import MTC
+
+# Example usage
+mtc = MTC()
+mtc.get_poses()
+```
+
+Tips: 
+- Marker template registration has to be done separately by the C# demo. 
+- Check camera connection and image frame before using this package. 
+
+### Features
+
+- Pythonic interface to the MicronTracker 4 library.
+- Simplifies the use of MicronTracker functionalities in Python applications.
+- Automatically locates the dynamic library based on system registry settings.
+
+### License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+### Support
+
+For any issues, please open an issue on the [GitHub repository](https://github.com/enhanced-telerobotics/pyMT4/issues).

setup.py

@@ -0,0 +1,28 @@
+from setuptools import setup, find_packages
+
+VERSION = "0.1.0"
+DESCRIPTION = "Python binding for MicronTracker 4"
+
+setup(
+    name='pyMT4',
+    version=VERSION,
+    description=DESCRIPTION,
+    long_description=open('README.md').read(),
+    long_description_content_type='text/markdown',
+    author='Shuyuan Yang',
+    author_email='sxy841@case.edu',
+    url='https://github.com/enhanced-telerobotics/pyMT4',
+    license='MIT',
+    packages=find_packages(),
+    install_requires=[
+        'numpy',
+    ],
+    classifiers=[
+        'Development Status :: 3 - Alpha',
+        'Intended Audience :: Science/Research',
+        'Programming Language :: Python :: 3',
+        'License :: OSI Approved :: MIT License',
+        'Operating System :: Microsoft :: Windows',
+    ],
+    python_requires='>=3.8',
+)