SDK Setup for dummies

[Ben Wood]

Is there a guide for setting up the sdk with Pro Tools.
I’ve read the documentation but I’m not very familiar with scripting.
I’ve had look for a YouTube video.
I’m using 2023.12 on Monterey with Xcode 14.2 I think and the latest Python build.
Many thanks

[Ben Wood]

If I try run the following in terminal:
python3 setup/build_cpp_ptsl_sdk.py --target ptsl.client.cpp --config Debug [--arch] [--os_version]

I get

zsh: no matches found: [--arch]

I've tried putting the full path to the sdk setup folder

python3 /Users/monterey/Downloads/PTSL_SDK_CPP.2023.12.2.0.813759/setup/build_cpp_ptsl_sdk.py --target ptsl.client.cpp --config Debug [--arch] [--os_version]

again I get

zsh: no matches found: [--arch]

If I remote the [--arch], it get further

Installing build dependencies ... done
Getting requirements to build wheel ... error
error: subprocess-exited-with-error

× Getting requirements to build wheel did not run successfully.
│ exit code: 1
╰─> [54 lines of output]
running egg_info
writing lib/PyYAML.egg-info/PKG-INFO
writing dependency_links to lib/PyYAML.egg-info/dependency_links.txt
writing top-level names to lib/PyYAML.egg-info/top_level.txt
Traceback (most recent call last):
File "/Users/monterey/Downloads/PTSL_SDK_CPP.2023.12.2.0.813759/Config/.venv/lib/python3.12/site-packages/pip/_vendor/pyproject_hooks/_in_process/_in_process.py", line 353, in <module>
main()
File "/Users/monterey/Downloads/PTSL_SDK_CPP.2023.12.2.0.813759/Config/.venv/lib/python3.12/site-packages/pip/_vendor/pyproject_hooks/_in_process/_in_process.py", line 335, in main
json_out['return_val'] = hook(**hook_input['kwargs'])
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/Users/monterey/Downloads/PTSL_SDK_CPP.2023.12.2.0.813759/Config/.venv/lib/python3.12/site-packages/pip/_vendor/pyproject_hooks/_in_process/_in_process.py", line 118, in get_requires_for_build_wheel
return hook(config_settings)
^^^^^^^^^^^^^^^^^^^^^
File "/private/var/folders/yy/h022hmh17zx1d45kcp2nx_940000gn/T/pip-build-env-sedyqkwv/overlay/lib/python3.12/site-packages/setuptools/build_meta.py", line 325, in get_requires_for_build_wheel
return self._get_build_requires(config_settings, requirements=['wheel'])
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^
File "/private/var/folders/yy/h022hmh17zx1d45kcp2nx_940000gn/T/pip-build-env-sedyqkwv/overlay/lib/python3.12/site-packages/setuptools/build_meta.py", line 295, in _get_build_requires
self.run_setup()
File "/private/var/folders/yy/h022hmh17zx1d45kcp2nx_940000gn/T/pip-build-env-sedyqkwv/overlay/lib/python3.12/site-packages/setuptools/build_meta.py", line 311, in run_setup
exec(code, locals())
File "<string>", line 288, in <module>
File "/private/var/folders/yy/h022hmh17zx1d45kcp2nx_940000gn/T/pip-build-env-sedyqkwv/overlay/lib/python3.12/site-packages/setuptools/__init__.py", line 103, in setup
return distutils.core.setup(**attrs)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/private/var/folders/yy/h022hmh17zx1d45kcp2nx_940000gn/T/pip-build-env-sedyqkwv/overlay/lib/python3.12/site-packages/setuptools/_distutils/core.py", line 185, in setup
return run_commands(dist)
^^^^^^^^^^^^^^^^^^
File "/private/var/folders/yy/h022hmh17zx1d45kcp2nx_940000gn/T/pip-build-env-sedyqkwv/overlay/lib/python3.12/site-packages/setuptools/_distutils/core.py", line 201, in run_commands
dist.run_commands()
File "/private/var/folders/yy/h022hmh17zx1d45kcp2nx_940000gn/T/pip-build-env-sedyqkwv/overlay/lib/python3.12/site-packages/setuptools/_distutils/dist.py", line 969, in run_commands
self.run_command(cmd)
File "/private/var/folders/yy/h022hmh17zx1d45kcp2nx_940000gn/T/pip-build-env-sedyqkwv/overlay/lib/python3.12/site-packages/setuptools/dist.py", line 963, in run_command
super().run_command(command)
File "/private/var/folders/yy/h022hmh17zx1d45kcp2nx_940000gn/T/pip-build-env-sedyqkwv/overlay/lib/python3.12/site-packages/setuptools/_distutils/dist.py", line 988, in run_command
cmd_obj.run()
File "/private/var/folders/yy/h022hmh17zx1d45kcp2nx_940000gn/T/pip-build-env-sedyqkwv/overlay/lib/python3.12/site-packages/setuptools/command/egg_info.py", line 321, in run
self.find_sources()
File "/private/var/folders/yy/h022hmh17zx1d45kcp2nx_940000gn/T/pip-build-env-sedyqkwv/overlay/lib/python3.12/site-packages/setuptools/command/egg_info.py", line 329, in find_sources
mm.run()
File "/private/var/folders/yy/h022hmh17zx1d45kcp2nx_940000gn/T/pip-build-env-sedyqkwv/overlay/lib/python3.12/site-packages/setuptools/command/egg_info.py", line 551, in run
self.add_defaults()
File "/private/var/folders/yy/h022hmh17zx1d45kcp2nx_940000gn/T/pip-build-env-sedyqkwv/overlay/lib/python3.12/site-packages/setuptools/command/egg_info.py", line 589, in add_defaults
sdist.add_defaults(self)
File "/private/var/folders/yy/h022hmh17zx1d45kcp2nx_940000gn/T/pip-build-env-sedyqkwv/overlay/lib/python3.12/site-packages/setuptools/command/sdist.py", line 112, in add_defaults
super().add_defaults()
File "/private/var/folders/yy/h022hmh17zx1d45kcp2nx_940000gn/T/pip-build-env-sedyqkwv/overlay/lib/python3.12/site-packages/setuptools/_distutils/command/sdist.py", line 251, in add_defaults
self._add_defaults_ext()
File "/private/var/folders/yy/h022hmh17zx1d45kcp2nx_940000gn/T/pip-build-env-sedyqkwv/overlay/lib/python3.12/site-packages/setuptools/_distutils/command/sdist.py", line 336, in _add_defaults_ext
self.filelist.extend(build_ext.get_source_files())
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "<string>", line 204, in get_source_files
File "/private/var/folders/yy/h022hmh17zx1d45kcp2nx_940000gn/T/pip-build-env-sedyqkwv/overlay/lib/python3.12/site-packages/setuptools/_distutils/cmd.py", line 107, in __getattr__
raise AttributeError(attr)
AttributeError: cython_sources
[end of output]

note: This error originates from a subprocess, and is likely not a problem with pip.
error: subprocess-exited-with-error

× Getting requirements to build wheel did not run successfully.
│ exit code: 1
╰─> See above for output.

note: This error originates from a subprocess, and is likely not a problem with pip.

[notice] A new release of pip is available: 23.2.1 -> 23.3.2
[notice] To update, run: pip install --upgrade pip

An error occurred while running the command: Command 'source .venv/bin/activate && .venv/bin/python -m pip install -r requirements.txt && .venv/bin/python "/Users/monterey/Downloads/PTSL_SDK_CPP.2023.12.2.0.813759/Config/ptsl_build_script.py" --source_dir "/Users/monterey/Downloads/PTSL_SDK_CPP.2023.12.2.0.813759" --config Debug ' returned non-zero exit status 1.

Any Ideas?
TIA

[Kevin Peters]

You need to specify your arch and os. If you are on a Mac with Apple silicone and Ventura, try something like this:

python3 build_cpp_ptsl_sdk.py --target ptsl.client.cpp --config Debug -a armv8  -os 13.0

Also in terminal, you will need to be in the right directory first. I typical type

cd

then drag the parent folder that contains the setup folder (the one you mention in your command) onto the terminal window and hit enter.

[Ben Wood]

Thanks Kevin, that's really kind
the cd command really helped

Unfortunately I'm stilll stuck at the same place with the build wheel error.
I tried rolling back Python from 3.12.1 to 3.11.7.
Got further this time with references to Conan but I get
'ERROR: PtslClient/None: 'settings.compiler' value not defined'

Thanks

[Ben Wood]

Here's the full error

ERROR: PtslClient/None: 'settings.compiler' value not defined
Traceback (most recent call last):
File "/Users/monterey/Downloads/PTSL_SDK_CPP.2023.12.2.0.813759 2/Config/ptsl_build_script.py", line 175, in <module>
subprocess.run(conan_cmd, check=True)
File "/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/subprocess.py", line 571, in run
raise CalledProcessError(retcode, process.args,
subprocess.CalledProcessError: Command '['conan', 'install', PosixPath('/Users/monterey/Downloads/PTSL_SDK_CPP.2023.12.2.0.813759 2'), '-if', PosixPath('/Users/monterey/Downloads/PTSL_SDK_CPP.2023.12.2.0.813759 2/MacBuild/x86_64/Dependencies'), '-s:h', 'arch=x86_64', '-s:h', 'build_type=Debug', '-pr:b=default', '--build', 'missing', '--remote', 'conancenter', '-s:h', 'os.version=12.0', '-s:b', 'os.version=12.0']' returned non-zero exit status 1.

An error occurred while running the command: Command 'source .venv/bin/activate && .venv/bin/python -m pip install -r requirements.txt && .venv/bin/python "/Users/monterey/Downloads/PTSL_SDK_CPP.2023.12.2.0.813759 2/Config/ptsl_build_script.py" --source_dir "/Users/monterey/Downloads/PTSL_SDK_CPP.2023.12.2.0.813759 2" --config Debug --arch x86_64 --os 12.0' returned non-zero exit status 1.

[marianna]

Hi Ben

Im checking with our partner team of developers to see what we have in the way of documentation.

Back when they respond.

Marianna

[Ben Wood]

Hi Marianna

Thanks for you response.
I've tried updating from Monterey to Ventura
I tried updating Xtools to 15.
I still get the same 'build wheel error' using Python 3.12.1 or 'PtslClient/None: 'settings.compiler' value not defined' using Python 3.11.7.
Changing the Python version is the only thing that seems to make a difference.

Thanks

[kenley_m]

Hi Ben,

Sorry you ran into trouble building the SDK targets. You should be able to get around the python 3.12 and compiler settings issues by upgrading the version of conan used by the build script. To do this use a plain text editor to replace the current content of the requirements.txt file located in the top-level Config folder of the SDK package with the text below. If you run into any additional issues, please let me know.

# Copyright 2021-2024 by Avid Technology, Inc.
# CONFIDENTIAL: this document contains confidential information of Avid. Do not disclose to any third party. Use of the information contained in this document is subject to an Avid SDK license.

bottle==0.12.25
certifi==2023.11.17
charset-normalizer==3.3.2
cmake==3.25.0
colorama==0.4.6
conan==1.62.0
fasteners==0.19
idna==3.6
Jinja2==3.1.3
MarkupSafe==2.1.4
node-semver==0.6.1
patch-ng==1.17.4
pluginbase==1.0.1
Pygments==2.17.2
PyJWT==2.8.0
python-dateutil==2.8.2
PyYAML==6.0.1
requests==2.31.0
six==1.16.0
tqdm==4.66.1
urllib3==1.26.18

[Ben Wood]

Hi Kenley, thanks for your reply

No better I'm afraid, I get...

ERROR: PtslClient/None: 'settings.compiler' value not defined
Traceback (most recent call last):
File "/Users/monterey/Downloads/PTSL_SDK_CPP.2023.12.2.0.813759/Config/ptsl_build_script.py", line 175, in <module>
subprocess.run(conan_cmd, check=True)
File "/Library/Frameworks/Python.framework/Versions/3.12/lib/python3.12/subprocess.py", line 571, in run
raise CalledProcessError(retcode, process.args,
subprocess.CalledProcessError: Command '['conan', 'install', PosixPath('/Users/monterey/Downloads/PTSL_SDK_CPP.2023.12.2.0.813759'), '-if', PosixPath('/Users/monterey/Downloads/PTSL_SDK_CPP.2023.12.2.0.813759/MacBuild/x86_64/Dependencies'), '-s:h', 'arch=x86_64', '-s:h', 'build_type=Debug', '-pr:b=default', '--build', 'missing', '--remote', 'conancenter', '-s:h', 'os.version=13.0', '-s:b', 'os.version=13.0']' returned non-zero exit status 1.

An error occurred while running the command: Command 'source .venv/bin/activate && .venv/bin/python -m pip install -r requirements.txt && .venv/bin/python "/Users/monterey/Downloads/PTSL_SDK_CPP.2023.12.2.0.813759/Config/ptsl_build_script.py" --source_dir "/Users/monterey/Downloads/PTSL_SDK_CPP.2023.12.2.0.813759" --config Debug --arch x86_64 --os 13.0' returned non-zero exit status 1.

[kenley_m]

Hi Ben,

I'm wondering if you have the xcode command line tools installed based on that error. Could you open your copy of Xcode and go to Xcode -> Settings -> Locations (tab) and make sure something is selected in the Command Line Tools drop down?

If it's empty select the tools version for your xcode and try building again.

If you still run into errors, please send me the contents of your default conan profile (~/.conan/profiles/default) and ~/.conan/settings.yml.