examplelspserver 0.0.3.2

python packaging tutorial

exampleDSL for reference

Optional: check python packages

• update package manager tools
  • python -m pip install --upgrade pip setuptools wheel
• check if python package virtualenv is installed if Python < 3.3 is used else a subset of it has been integrated into the standard library under venv
  • python -m pip show virtualenv
  • if not install package virtualenv into global system environment
    • python -m pip install virtualenv

Install Server Dependencies

• generate virtual environment in directory .venv using the standard library venv
  • python -m venv .venv
  • alternative use virtualenv, see optional python packages
• activate virtual environment .venv
  • source .venv/bin/activate
• install antlr4-python3-runtime, Jinja2, mock, pygls and pytest package into virtual environment .venv
  • python -m pip install antlr4-python3-runtime Jinja2 mock pygls pytest

Optional: update npm and node

• check npm version
  • npm --version
• install latest npm version globally (-g or --global)
  • sudo npm install -g npm@latest
• install latest node version
  • sudo n latest
• Install the dependencies to the global mode (-g or --global)
  • sudo npm update -g

Install Client Dependencies

• Goto extension directory python-oceandsls/example-dsl
• Install the dependencies to the local node_modules
  • npm install

Run Example using VSCode

• Open python-oceandsls/example-dsl in VSCode
• Trust author files in python-oceandsls/example-dsl
• Goto Run and Debug
  • Ctrl/Cmd+Shift+D
• Select Server + Client
• Start Debugging via F5 or GUI
• Open a *.odsl file
• If server is working correctly notification shows Text Document Did Open

Troubleshooting

• If VS Code doesn`t automatically locate the interpreter of the virtual environment. Set it manually

  • Open Command prompt Ctrl/Cmd+Shift+P
    • Run select interpreter command Python: Select Interpreter
  • Alternative create .vscode/settings.json file in python-oceandsls/example-dsl directory and set python.defaultInterpreterPath to point to the virtual environment

    • settings.json

      {
          // set Python Interpreter relative to workspaceFolder to virtual environment '.venv'
          "python.defaultInterpreterPath": "${workspaceFolder}/../.venv/bin/python",
          // alternative
          //"python.defaultInterpreterPath": "../.venv",
          // deprecated
          // "python.pythonPath": "${workspaceFolder}/../.venv/bin/python",
      
          // Pylance VSCode code analysis and auto-completion using Python 3.10
          "python.analysis.extraPaths": [
              "{workspaceFolder}/../.venv/lib/python3.10/site-packages/:${workspaceFolder}/../antlrLib/"
          ],
      
      
          // Object with environment variables that will be added to the VS Code process to be used by the terminal on OS X
          "terminal.integrated.env.osx": {"PYTHONPATH": "${workspaceFolder}/.."},
      
          // Object with environment variables that will be added to the VS Code process to be used by the terminal on Linux
          "terminal.integrated.env.linux": {"PYTHONPATH": "${workspaceFolder}/.."},
      
          // Object with environment variables that will be added to the VS Code process to be used by the terminal on Windows
          "terminal.integrated.env.windows": {"PYTHONPATH": "${workspaceFolder}/.."},
      }
      

• If npm version conflicts exists change npm to the required version

  • E.g. reset npm version to 9.2.0
    • sudo npm install -g npm@9.2.0