Refactor agentql repo (#97)

* Refactor agentql repo

* Update github action workflow

* Change file name to main

* Update folder name / readme

* add some missing files back into JS examples

* rename folder

* Update workflow

* Update template folder name as well

* Address comments

* Add JS template file for CLI (#99)

Author: frankfeng98

.dockerignore

@@ -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/js-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 .

.github/workflows/precommit.yml renamed to .github/workflows/python-precommit.yml

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

.gitignore

@@ -0,0 +1,64 @@
+const { chromium } = require('playwright');
+const { wrap, configure } = require('agentql');
+
+// Set URLs to the desired websites
+const WEBSITE_URL_1 = "<Replace with the correct url>";
+const WEBSITE_URL_2 = "<Replace with the correct url>";
+const WEBSITE_URL_3 = "<Replace with the correct url>";
+
+async function main() {
+  // Configure the AgentQL API key
+  configure({ apiKey: process.env.AGENTQL_API_KEY });
+
+  const browser = await chromium.launch({ headless: false });
+  const context = await browser.newContext();
+
+  // Open multiple tabs in the same browser context to fetch data concurrently
+  await Promise.all([
+    fetchData(context, WEBSITE_URL_1),
+    fetchData(context, WEBSITE_URL_2),
+    fetchData(context, WEBSITE_URL_3),
+  ]);
+
+  await browser.close();
+}
+
+async function fetchData(context, sessionUrl) {
+  // Create a page in a new tab in the browser context and wrap it to get access to the AgentQL's querying API
+  const page = await wrap(await context.newPage());
+  await page.goto(sessionUrl);
+
+  // Update the query to locate the desired element on the page
+  const elementsQuery = `
+  {
+      search_input
+      search_btn
+  }
+  `;
+
+  // Locate desired web elements using AgentQL's queryElements() method
+  const response = await page.queryElements(elementsQuery);
+  // Update to use the actual query terms to interact with the elements
+  await response.search_input.fill("<Replace with needed search query>");
+  await response.search_btn.click();
+
+  // Update the query to fetch the desired data from the page
+  const dataQuery = `
+  {
+      products[] {
+          name
+          price
+      }
+  }
+  `;
+
+  // Fetch the data from the page using AgentQL's queryData() method
+  const data = await page.queryData(dataQuery);
+  // Update to use the actual keys corresponding to query terms
+  console.log(`Prices fetched from ${sessionUrl}:`);
+  for (const product of data.products) {
+    console.log(`Product: ${product.name}, Price: ${product.price}`);
+  }
+}
+
+main();

.stylelintrc.js

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