Download Python 

Download and install Python, currently version 3.11.2, except for Windows which currently can manage 3.9.X due to a C compilation issue with a dependency

• For Windows 64bit version
  

  Note
  Windows currently has issues with xmlsec library, And it only supports Python 3.9.x

• For Linux

• For macOs

Note
Disable the path length limit to prevent issues in windows environment Image Added

Setup Environment

Clone and Set The Branch

1. Clone the project from the repository

   Code Block
   git clone https://source.digital.accenture.com/scm/st/search-api.git

2. Verify the current brach executing the command below, it should be main

   Code Block
   git branch

   1. If the branch wasn't main, checkout the main branch:

      Code Block
      git checkout main

3. Create a branch to work on, using the branch folder assigned <branch_folder>/develop (we recommend using develop as your working branch)

   Code Block
   git checkout -b <branch_folder>/develop

Create & Use A Virtual Environment

We recommend the creation of a virtual environment to prevent python dependencies conflicts, is also helpful if you have multiple versions of python in the same machine

python -m venv {name_of_your_venv}

python3 -m venv {name_of_your_venv}

If you want to name you virtual environment test then the command would look like this

python -m venv test

python3 -m venv test

Activate Virtual Environment

To use your virtual environment you need to activated, the activation command changes depending on your OS

• For Windows

  Code Block
  {name_of_your_venv}\Scripts\activate.bat

• For Unix or macOS, run:

  Code Block
  source {name_of_your_venv}/bin/activate

  Note
  If using a bash console on Windows, then you have to execute Code Block source {name_of_your_venv}/Scripts/activate

Following the example of the venv named test, the commands would look like this:

• Windows

  Code Block
  test\Scripts\activate.bat

• Unix or macOS:

  Code Block
  source test/bin/activate

Install Python Dependencies

If you are working on Windows you may need to download Build Tools for Visual Studio and install the Universal Windows Platform build tools (Probably will require Admin rights). Unix bases OS should have any issues

Once the virtual environment is activates (if you did one, otherwise is the same process), install the dependencies stored in the pyproject.toml. To install them execute the following command:

pip install -e .

If that didn't work try

python -m pip install -e .

python3 -m pip install -e .

Install PyQPL local library

After the installation is successful, proceed to install PyQPL

pip install lib/pyqpl-VERSION_IN_PROJECT-py3-none-any.whl

Why Use PyQPL?

PyQPL is our proprietary dependency, is a versatile scripting language that simplifies the construction of complex queries. It offers engine agnosticism, query parsing, manual query building, query translation, Saga coupling for advanced processing, synonym expansion, and support for custom operators. With PyQPL, you can write standardized queries irrespective of the underlying search engine, making it flexible and efficient for query processing tasks.

Is already seamlessly integrated into the Query Stage, and can be enable or disabled as need it, probably if you are working or had work with Search API previously, have used PyQPL without notice.

Uninstall PyQPL local library

In case you need to upgrade the version of pyqpl, we recommend to uninstall the current library using the command

pip uninstall pyqpl

Delete the whl file and replace it with the new one, and use the same command as above to install the new one

Startup The Server

In root folder execute

python uvicorn_server.py 

python3 uvicorn_server.py