*

2025-05-13 01:34:53 +03:00
parent 427735e23d
commit 83f3f1c7d4
945 changed files with 633484 additions and 0 deletions
@@ -0,0 +1,132 @@
+"""
+This script is used to deploy the ODrive python tools to PyPi
+so that users can install them easily with
+"pip install odrive"
+
+To install the package and its dependencies locally, run:
+    sudo pip install -r requirements.txt
+
+To build and package the python tools into a tar archive:
+    python setup.py sdist
+
+Warning: Before you proceed, be aware that you can upload a
+specific version only once ever. After that you need to increment
+the hotfix number. Deleting the release manually on the PyPi
+website does not help.
+
+Use TestPyPi while developing.
+
+To build, package and upload the python tools to TestPyPi, run:
+    python setup.py sdist upload -r pypitest
+To make a real release ensure you're at the release commit
+and then run the above command without the "test" (so just "pypi").
+
+To install a prerelease version from test index:
+(extra-index-url is there because some packages don't upload to test server)
+    sudo pip install --pre --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ --no-cache-dir odrive
+
+
+PyPi access requires that you have set up ~/.pypirc with your
+PyPi credentials and that your account has the rights
+to publish packages with the name odrive.
+"""
+
+# Set to true to make the current release
+is_release = True
+
+# Set to true to make an official post-release, rather than dev of new version
+is_post_release = False
+post_rel_num = 0
+
+# To test higher numbered releases, bump to the next rev
+devnum = 0
+bump_rev = not is_post_release and not is_release
+
+# TODO: add additional y/n prompt to prevent from erroneous upload
+
+from setuptools import setup
+import os
+import sys
+
+if sys.version_info < (3, 3):
+  import exceptions
+  PermissionError = exceptions.OSError
+
+creating_package = "sdist" in sys.argv
+
+# Load version from Git tag
+import odrive.version
+version = odrive.version.get_version_str(
+    git_only=creating_package,
+    is_post_release=is_post_release,
+    bump_rev=bump_rev,
+    release_override=is_release)
+
+# If we're currently creating the package we need to autogenerate
+# a file that contains the version string
+if creating_package:
+  if is_post_release:
+    version += str(post_rel_num)
+  elif (devnum > 0):
+    version += str(devnum)
+
+  version_file_path = os.path.join(os.path.dirname(os.path.realpath(__file__)), 'odrive', 'version.txt')
+  with open(version_file_path, mode='w') as version_file:
+    version_file.write(version)
+  
+  # Temporarily link fibre into the python tools directory
+  # TODO: distribute a fibre package separately
+  fibre_src = os.path.join(os.path.dirname(os.path.dirname(
+                    os.path.realpath(__file__))),
+                    "Firmware", "fibre", "python", "fibre")
+  fibre_link = os.path.join(os.path.dirname(
+                    os.path.realpath(__file__)), "fibre")
+  if not os.path.exists(fibre_link):
+    if sys.version_info > (3, 3):
+      os.symlink(fibre_src, fibre_link, target_is_directory=True)
+    else:
+      os.symlink(fibre_src, fibre_link)
+
+# TODO: find a better place for this
+if not creating_package:
+  import platform
+  if platform.system() == 'Linux':
+    try:
+      odrive.version.setup_udev_rules(None)
+    except Exception:
+      print("Warning: could not set up udev rules. Run `sudo odrivetool udev-setup` to try again.")
+
+try:
+  setup(
+    name = 'odrive',
+    packages = ['odrive', 'odrive.dfuse', 'fibre'],
+    scripts = ['odrivetool', 'odrivetool.bat', 'odrive_demo.py'],
+    version = version,
+    description = 'Control utilities for the ODrive high performance motor controller',
+    author = 'Oskar Weigl',
+    author_email = 'oskar.weigl@odriverobotics.com',
+    license='MIT',
+    url = 'https://github.com/madcowswe/ODrive',
+    keywords = ['odrive', 'motor', 'motor control'],
+    install_requires = [
+      'ipython',  # Used to do the interactive parts of the odrivetool
+      'PyUSB',    # Required to access USB devices from Python through libusb
+      'PySerial', # Required to access serial devices from Python
+      'requests', # Used to by DFU to load firmware files
+      'IntelHex', # Used to by DFU to download firmware from github
+      'matplotlib', # Required to run the liveplotter
+      'monotonic', # For compatibility with older python versions
+      'appdirs',  # Used to find caching directory
+      'pywin32 >= 222; platform_system == "Windows"' # Required for fancy terminal features on Windows
+    ],
+    package_data={'': ['version.txt']},
+    classifiers = [],
+  )
+
+  # TODO: include README
+
+finally:
+  # clean up
+  if creating_package:
+    os.remove(version_file_path)
+    os.remove(fibre_link)