Skip to content

Latest commit

 

History

History
61 lines (40 loc) · 3.9 KB

develop-macos.md

File metadata and controls

61 lines (40 loc) · 3.9 KB
Raw

Developing on MacOS

Pre-requisites

You need Python 3.11.7 and some dependencies to run Wingman. We recommend using a virtual environment to keep your system clean. If you don't know what that is, don't worry, we'll guide you through the process. If you don't want to use a virtual environment, you can skip the pyenv parts and just run pip install -r requirements.txt in the repository root once you have Python installed.

brew update && brew upgrade                             # upgrade all packages
brew install pyenv portaudio pyobjc-framework-Quartz    # install dependencies
pyenv install 3.11.7                                    # install Python with pyenv
pyenv global 3.11.7                                     # set your global Python version

Then add eval "$(pyenv init --path)" to your ~/.zshrc or ~/.bashrc so that you can just run python instead of python3 in your terminal.

Restart the terminal. Test with python --version and python3 --version.

Install dependencies

Checkout the repository and start a terminal in the root folder.

python -m venv venv                 # create a virtual environment
source venv/bin/activate            # activate the virtual environment
pip install -r requirements.txt     # install dependencies

Setup Visual Studio Code

Once you have everything installed, open the root folder in Visual Studio Code. It should automatically detect the virtual environment (if you created one) and ask you to install the dependencies. If not, you can do so manually by opening the command palette (Ctrl+Shift+P) and running Python: Select Interpreter. Then select the virtual environment you created.

Open main.py and run it. You should see the Wingman AI window should pop up. If it doesn't, make sure that:

  • you have the virtual environment selected
  • you have installed all dependencies using pip install -r requirements.txt
  • the integrated VSCode terminal ran the file from the repository root directory. At least on MacOS, it sometimes runs it from an outside directory, which causes issues with the relative paths. In that case, cd into the correct directory and run again.
  • you have main.py active in the editor when you hit F5 to run it

We also suggest to install the recommended extensions if you haven't already. We're not forcing any strict syntactic coding styles right now but that might (have to) change in the future. If that will happen, pylint will certainly be used to enforce the style and it can help you with some basic stuff already if you aren't super familiar with Python.

Allow access to microphone and input event monitoring

VSCode will ask you to give it access to your mic and to monitor your input events. You have to allow both for Wingman to work. If you start the app from the terminal and see the message

This process is not trusted! Input event monitoring will not be possible until it is added to accessibility clients.

Go to System Settings > Privacy & Security > Accessibility and enable VSCode there, too.

Setup whispercpp

The release version of Wingman AI bundles and uses whispercpp as local STT service and autostarts the service when neeed. Unfortunately, this only works on Windows. On MacOS, you have to start the service manually.

  • Download the latest stable MacOS release from the whispercpp repository or build it from source
  • Download a model and copy it to whispercpp/models directory. We recommend to start with the ggml-base.bin model.
  • Start whispercpp on the host and port configured in Wingman AI. You can check the Wingman AI client and it will tell you the exact start cmd to execute.
  • Restart Wingman AI Core and it should connect to your running whispercpp instance.

You obviously can't change the whispercpp settings in the Wingman AI UI on MacOS but the UI might give you a hint on how you can configure whispercpp server.