Refactor agentql repo

.github/workflows/js-precommit.yml

@@ -0,0 +1,32 @@
+name: JSPre-commit checks
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+    paths:
+      - "examples/JS/**"
+
+jobs:
+  js-pre-commit:
+    name: JS Pre-commit checks
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: "18"
+
+      - name: Install dependencies
+        working-directory: ./examples/JS
+        run: npm install
+
+      - name: Run ESLint
+        working-directory: ./examples/JS
+        run: npm run lint
+
+      - name: Run Prettier
+        working-directory: ./examples/JS
+        run: npx prettier --check .

.github/workflows/precommit.yml → .github/workflows/python-precommit.yml

@@ -1,8 +1,10 @@
-name: Pre-commit checks
+name: Python Pre-commit checks
 
 on:
   pull_request:
     types: [opened, synchronize, reopened]
+    paths:
+      - "examples/Python/**"
 
 jobs:
   python-pre-commit:
@@ -32,44 +34,25 @@ jobs:
       #  ----- install dependencies -----
       #----------------------------------------------
       - name: Install dependencies
+        working-directory: ./examples/Python
         run: |
           poetry install --no-interaction --no-root --with dev
 
       - name: Lint check
+        working-directory: ./examples/Python
         run: pylint --disable=R,C application_examples examples
 
       - name: Code style check
+        working-directory: ./examples/Python
         run: black . --check
 
       - name: Imports sort check
+        working-directory: ./examples/Python
         uses: isort/isort-action@master
 
       - name: Static check
+        working-directory: ./examples/Python
         uses: jakebailey/pyright-action@v2
         continue-on-error: true
         with:
           pylance-version: latest-release
-
-  js-pre-commit:
-    name: JS Pre-commit checks
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout Repository
-        uses: actions/checkout@v4
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: "20"
-
-      - name: Install dependencies
-        working-directory: ./javascript-sdk
-        run: npm install
-
-      - name: Run ESLint
-        working-directory: ./javascript-sdk
-        run: npm run lint
-
-      - name: Run Prettier
-        working-directory: ./javascript-sdk
-        run: npx prettier --check .

.gitignore

@@ -37,4 +37,6 @@ tmp/
 
 *env.local
 
-javascript-sdk/node_modules
+examples/JS/node_modules/
+examples/Python/__pycache__/
+examples/Python/.venv/

.vscode/settings.json

@@ -16,7 +16,7 @@
   },
   "eslint.workingDirectories": [
     {
-      "directory": "./javascript-sdk",
+      "directory": "./examples/JS",
       "changeProcessCWD": true
     }
   ],
@@ -34,8 +34,8 @@
   ],
   "pylint.importStrategy": "fromEnvironment",
   "pylint.args": [
-    "--rcfile=.pylintrc"
+    "--rcfile=./examples/Python/.pylintrc"
   ],
-  "python.analysis.typeCheckingMode": "standard",
+  "python.analysis.typeCheckingMode": "basic",
   "editor.rulers": [100]
 }

.prettierignore → examples/JS/.prettierignore

@@ -15,11 +15,3 @@
 !.*
 .eslintcache
 .lint-todo/
-
-# ember-try
-/.node_modules.ember-try/
-/bower.json.ember-try
-/npm-shrinkwrap.json.ember-try
-/package.json.ember-try
-/package-lock.json.ember-try
-/yarn.lock.ember-try

examples/close_cookie_dialog/README.md → examples/Python/close_cookie_dialog/README.md

@@ -5,11 +5,11 @@ This example demonstrates how to use AgentQL close a site's dialog for rejecting
 ## Run the script
 
 - [Install AgentQL SDK](https://docs.agentql.com/installation/sdk-installation)
-- Save this python file locally as **close_cookie_dialog.py**
+- Save this python file locally as **main.py**
 - Run the following command from the project's folder:
 
 ```bash
-python3 close_cookies.py
+python3 main.py
 ```
 
 ## Play with the query

examples/close_popup/README.md → examples/Python/close_popup/README.md

@@ -5,11 +5,11 @@ This example demonstrates how to close popup windows (like promotion form) with
 ## Run the script
 
 - [Install AgentQL SDK](https://docs.agentql.com/installation/sdk-installation)
-- Save this python file locally as **close_popup.py**
+- Save this python file locally as **main.py**
 - Run the following command from the project's folder:
 
 ```bash
-python3 close_popup.py
+python3 main.py
 ```
 
 ## Play with the query

application_examples/collect_ecommerce_pricing_data/README.md → examples/Python/collect_ecommerce_pricing_data/README.md

@@ -5,11 +5,11 @@ This is an example of how to collect pricing data from e-commerce website using
 ## Run the script
 
 - [Install AgentQL SDK](https://docs.agentql.com/installation/sdk-installation)
-- Save this python file locally as **collect_pricing_data.py**
+- Save this python file locally as **main.py**
 - Run the following command from the project's folder:
 
 ```bash
-python3 collect_pricing_data.py
+python3 main.py
 ```
 
 ## Play with the query

examples/compare_product_prices/README.md → examples/Python/compare_product_prices/README.md

@@ -5,11 +5,11 @@ This example demonstrates how to compare product prices across websites with que
 ## Run the script
 
 - [Install AgentQL SDK](https://docs.agentql.com/installation/sdk-installation)
-- Save this python file locally as **compare_product_prices.py**
+- Save this python file locally as **main.py**
 - Run the following command from the project's folder:
 
 ```bash
-python3 compare_product_prices.py
+python3 main.py
 ```
 
 ## Play with the query

examples/debug_script/README.md → examples/Python/debug_script/README.md

@@ -5,12 +5,12 @@ This example demonstrates how to debug AgentQL scripts in both synchronous and a
 ## Run the script
 
 - [Install AgentQL SDK](https://docs.agentql.com/installation/sdk-installation)
-- Save this python file locally as **debug_agentql_script.py** for debugging in **synchronous environment** or **async_debug_agentql_script.py** for debugging in **asynchronous environment**
+- Save this python file locally as **main.py** for debugging in **synchronous environment** or **async_main.py** for debugging in **asynchronous environment**
 - Run the following command from the project's folder:
 
 ```bash
-python3 debug_agentql_script.py
-python3 async_debug_agentql_script.py
+python3 main.py
+python3 async_main.py
 ```
 
 ## Play with the query

examples/first_steps/README.md → examples/Python/first_steps/README.md

@@ -5,11 +5,11 @@ This is an example of collecting pricing data from e-commerce website using Agen
 ## Run the script
 
 - [Install AgentQL SDK](https://docs.agentql.com/installation/sdk-installation)
-- Save this python file locally as **first_steps.py**
+- Save this python file locally as **main.py**
 - Run the following command from the project's folder:
 
 ```bash
-python3 first_steps.py
+python3 main.py
 ```
 
 ## Play with the query

examples/get_by_prompt/README.md → examples/Python/get_by_prompt/README.md

@@ -5,11 +5,11 @@ This example shows how to use AgentQL's [`get_by_prompt`](https://docs.agentql.c
 ## Run the script
 
 - [Install AgentQL SDK](https://docs.agentql.com/installation/sdk-installation)
-- Save this python file locally as **get_by_prompt.py**
+- Save this python file locally as **main.py**
 - Run the following command from the project's folder:
 
 ```bash
-python3 get_by_prompt.py
+python3 main.py
 ```
 
 ## Play with the query

examples/infinite_scroll/README.md → examples/Python/infinite_scroll/README.md

@@ -5,11 +5,11 @@ This example demonstrates how to load additional content on pages that load cont
 ## Run the script
 
 - [Install AgentQL SDK](https://docs.agentql.com/installation/sdk-installation)
-- Save this python file locally as **infinite_scroll.py**
+- Save this python file locally as **main.py**
 - Run the following command from the project's folder:
 
 ```bash
-python3 infinite_scroll.py
+python3 main.py
 ```
 
 ## Adjust the scrolling method

examples/interact_with_external_or_existing_browser/README.md → examples/Python/interact_with_external_or_existing_browser/README.md

@@ -5,7 +5,7 @@ This example demonstrates how to interact with an external or existing browser w
 ## Run the script
 
 - [Install AgentQL SDK](https://docs.agentql.com/installation/sdk-installation)
-- Save this Python file locally as **run_script_with_local_browser.py**
+- Save this Python file locally as **main.py**
 - Close your Google Chrome application if it is open.
 - If you're using **Mac**, open the terminal and run the following command:
 
@@ -22,12 +22,12 @@ chrome.exe --remote-debugging-port=9222
 **Make sure to replace `chrome.exe` with the path to your Chrome executable if it's not already in your system's PATH.**
 
 - In the browser window that's opened, select the Google profile you would like to use for this session.
-- In `run_script_with_local_browser.py`, replace variable `WEBSOCKET_URL`'s placeholder value with the actual WebSocket URL returned in terminal or command prompt. The URL should be in the format of `ws://127.0.0.1:9222/devtools/browser/387adf4c-243f-4051-a181-46798f4a46f4`.
+- In `main.py`, replace variable `WEBSOCKET_URL`'s placeholder value with the actual WebSocket URL returned in terminal or command prompt. The URL should be in the format of `ws://127.0.0.1:9222/devtools/browser/387adf4c-243f-4051-a181-46798f4a46f4`.
 
 - Run the following command from the project's folder:
 
 ```bash
-python3 run_script_with_local_browser.py
+python3 main.py
 ```
 
 - If you want to learn how to work with open pages, navigate to [Scrapeme website](https://scrapeme.live/shop/Charmander/) within the browser, and use `fetch_data_from_open_website_page()` method in the script to fetch data from the page.

examples/list_query_usage/README.md → examples/Python/list_query_usage/README.md

@@ -5,11 +5,11 @@ This example demonstrates how to query a list of items on the page.
 ## Run the script
 
 - [Install AgentQL SDK](https://docs.agentql.com/installation/sdk-installation)
-- Save this python file locally as **list_query_usage.py**
+- Save this python file locally as **main.py**
 - Run the following command from the project's folder:
 
 ```bash
-python3 list_query_usage.py
+python3 main.py
 ```
 
 ## Play with it

examples/log_into_sites/README.md → examples/Python/log_into_sites/README.md

@@ -5,11 +5,11 @@ This is an example shows how to login into websites by retrieving and interactin
 ## Run the script
 
 - [Install AgentQL SDK](https://docs.agentql.com/installation/sdk-installation)
-- Save this python file locally as **log_into_sites.py**
+- Save this python file locally as **main.py**
 - Run the following command from the project's folder:
 
 ```bash
-python3 log_into_sites.py
+python3 main.py
 ```
 
 ## Play with the query

application_examples/perform_sentiment_analysis/README.md → examples/Python/perform_sentiment_analysis/README.md

@@ -11,7 +11,7 @@ This example demonstrates how to perform sentiment analysis on YouTube comments
 pip install openai
 ```
 
-- Save this python file locally as **perform_sentiment_analysis.py**
+- Save this python file locally as **main.py**
 - Set your OpenAI API key as an environment variable with the following command:
 
 ```bash
@@ -21,7 +21,7 @@ export OPENAI_API_KEY="My API Key"
 - Run the following command from the project's folder:
 
 ```bash
-python3 perform_sentiment_analysis.py
+python3 main.py
 ```
 
 ## Play with the query

examples/run_script_in_headless_browser/README.md → examples/Python/run_script_in_headless_browser/README.md

@@ -5,11 +5,11 @@ This example demonstrates how to run the script in headless browser.
 ## Run the script
 
 - [Install AgentQL SDK](https://docs.agentql.com/installation/sdk-installation)
-- Save this python file locally as **run_in_headless_browser.py**
+- Save this python file locally as **main.py**
 - Run the following command from the project's folder:
 
 ```bash
-python3 run_in_headless_browser.py
+python3 main.py
 ```
 
 ## Play with the query

examples/run_script_online_in_google_colab/README.md → examples/Python/run_script_online_in_google_colab/README.md

@@ -5,7 +5,7 @@ This example demonstrates how to run AgentQL script in online development enviro
 ## Run the script
 
 - Go to [Google Colaboratory](https://colab.research.google.com/) website
-- Upload the **agentql.ipynb** file to Google Colab
+- Upload the **main.ipynb** file to Google Colab
 - Run the script by clicking the run button of each cell sequentially.
 
 ## Play with the query

examples/run_script_online_in_google_colab/run_script_online_in_google_colab.ipynb → examples/Python/run_script_online_in_google_colab/main.ipynb

@@ -2,9 +2,7 @@
   "cells": [
     {
       "cell_type": "markdown",
-      "metadata": {
-        "id": "NL1z6COzYn31"
-      },
+      "metadata": {},
       "source": [
         "This example demonstrates how to run AgentQL script in online development environment like [Google Colaboratory](https://colab.research.google.com/)."
       ]

examples/save_and_load_authenticated_session/README.md → examples/Python/save_and_load_authenticated_session/README.md

@@ -5,11 +5,11 @@ This example demonstrates how to save and load a authenticated state (i.e. signe
 ## Run the script
 
 - [Install AgentQL SDK](https://docs.agentql.com/installation/sdk-installation)
-- Save this python file locally as **save_and_load_authenticated_state.py**
+- Save this python file locally as **main.py**
 - Run the following command from the project's folder:
 
 ```bash
-python3 save_and_load_authenticated_state.py
+python3 main.py
 ```
 
 ## Play with the query