Merge branch 'main' into error-management-js

Author: DPende

.github/workflows/pylint.yml

@@ -8,17 +8,21 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - name: Install the latest version of rye
-        uses: eifinger/setup-rye@v3
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
       - name: Install dependencies
-        run: rye sync --no-lock
+        run: |
+          cd scrapegraph-py
+          uv sync --frozen
       - name: Analysing the code with pylint
-        run: rye run pylint-ci
+        run: |
+          cd scrapegraph-py
+          uv run poe pylint-ci
       - name: Check Pylint score
         run: |
           cd scrapegraph-py
-          pylint_score=$(rye run pylint-score-ci | grep 'Raw metrics' | awk '{print $4}')
+          pylint_score=$(uv run poe pylint-score-ci | grep 'Raw metrics' | awk '{print $4}')
           if (( $(echo "$pylint_score < 8" | bc -l) )); then
             echo "Pylint score is below 8. Blocking commit."
             exit 1

.github/workflows/python-publish.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python
       uses: actions/setup-python@v5
       with:

.github/workflows/release.yml

@@ -14,8 +14,8 @@ jobs:
         run: |
           sudo apt update
           sudo apt install -y git
-      - name: Install the latest version of rye
-        uses: eifinger/setup-rye@v3
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
       - name: Install Node Env
         uses: actions/setup-node@v4
         with:
@@ -28,12 +28,12 @@ jobs:
       - name: Build app
         run: |
           cd scrapegraph-py
-          rye sync --no-lock
-          rye build
+          uv sync --frozen
+          uv build
         id: build_cache
         if: success()
       - name: Cache build
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: scrapegraph-py/dist
           key: ${{ runner.os }}-build-${{ hashFiles('scrapegraph-py/dist/**') }}
@@ -60,18 +60,14 @@ jobs:
         with:
           fetch-depth: 0
           persist-credentials: false
-      - name: Go to scrapegraph-py folder
-        run: |
-          ls
-          cd ./scrapegraph-py
-      - name: Install the latest version of rye
-        uses: eifinger/setup-rye@v3
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
       - name: Setup Python environment
         run: |
           cd ./scrapegraph-py
-          rye sync
+          uv sync
       - name: Restore build artifacts
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: ./scrapegraph-py/dist
           key: ${{ runner.os }}-build-${{ hashFiles('./scrapegraph-py/dist/**') }}

scrapegraph-js/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

scrapegraph-py/CONTRIBUTING.MD renamed to scrapegraph-js/CONTRIBUTING.MD

@@ -2,11 +2,11 @@ import { getCredits } from 'scrapegraph-sdk';
 import 'dotenv/config';
 
 try {
-    const apiKey = process.env.SGAI_APIKEY;
+	const apiKey = process.env.SGAI_APIKEY;
 
-    const myCredit = await getCredits(apiKey);
+	const myCredit = await getCredits(apiKey);
 
-    console.log(myCredit)
+	console.log(myCredit)
 } catch (error) {
-    console.error(error)
+	console.error(error)
 }

scrapegraph-py/LICENSE renamed to scrapegraph-js/LICENSE

@@ -2,12 +2,12 @@ import { getSmartScraperRequest } from 'scrapegraph-sdk';
 import 'dotenv/config';
 
 try {
-    const apiKey = process.env.SGAI_APIKEY;
-    const requestId = '3fa85f64-5717-4562-b3fc-2c963f66afa6'
+  const apiKey = process.env.SGAI_APIKEY;
+  const requestId = '3fa85f64-5717-4562-b3fc-2c963f66afa6'
 
-    const requestInfo = await getSmartScraperRequest(apiKey, requestId);
+  const requestInfo = await getSmartScraperRequest(apiKey, requestId);
 
-    console.log(requestInfo);
+  console.log(requestInfo);
 } catch (error) {
-    console.error(error);
+  console.error(error);
 }

scrapegraph-js/examples/getCredits_example.js

@@ -18,49 +18,77 @@ npm install scrapegraph-js
 First, import the required functions:
 
 ```javascript
-import { scrape, credits, feedback } from 'scrapegraph-js';
+import { smartScraper, getSmartScraperRequest, getCredits, sendFeedback } from 'scrapegraph-sdk';
 ```
 
 ### Scraping Websites
 
+#### Basic scraping
+
 ```javascript
-const apiKey = 'your_api_key';
-const url = 'https://example.com';
+import { smartScraper } from 'scrapegraph-sdk';
 
-// Basic scraping
-const result = await scrape(apiKey, url);
-console.log(JSON.parse(result));
+const apiKey = process.env.SGAI_APIKEY;
+const url = 'https://scrapegraphai.com';
+const prompt = 'What does the company do?';
 
-// Scraping with custom options
-const options = {
-  elements: ['h1', '.product-price'],
-  wait_for: '.specific-element',
-  javascript: true
-};
+try {
+  const response = await smartScraper(apiKey, url, prompt);
+  console.log(response);
+} catch (error) {
+  console.error(error);
+}
+```
+
+#### Scraping with custom output schema
+
+```javascript
+import { smartScraper } from 'scrapegraph-sdk';
 
-const customResult = await scrape(apiKey, url, options);
-console.log(JSON.parse(customResult));
+const apiKey = 'your_api_key';
+const url = 'https://scrapegraphai.com';
+const prompt = 'What does the company do?';
+const schema = //TODO
+
+try {
+  const response = await smartScraper(apiKey, url, prompt, schema);
+  console.log(response);
+} catch (error) {
+  console.error(error);
+}
 ```
 
 ### Checking Credits
 
 ```javascript
+import { getCredist } from 'scrapegraph-sdk';
+
 const apiKey = 'your_api_key';
 
-const creditsInfo = await credits(apiKey);
-console.log(JSON.parse(creditsInfo));
+try {
+	const myCredit = await getCredits(apiKey);
+	console.log(myCredit)
+} catch (error) {
+	console.error(error)
+}
 ```
 
 ### Submitting Feedback
 
 ```javascript
+import { sendFeedback } from 'scrapegraph-sdk';
+
 const apiKey = 'your_api_key';
-const requestId = 'request_id_from_scrape_response';
+const requestId = '16a63a80-c87f-4cde-b005-e6c3ecda278b';
 const rating = 5;
-const feedbackText = 'Great results!';
+const feedbackMessage = 'This is a test feedback message.';
 
-const feedbackResponse = await feedback(apiKey, requestId, rating, feedbackText);
-console.log(JSON.parse(feedbackResponse));
+try {
+  const feedback_response = await sendFeedback(apiKey, requestId, rating, feedbackMessage);
+  console.log(feedback_response);
+} catch (error) {
+  console.error(error)
+}
 ```
 
 ## API Reference
@@ -92,17 +120,20 @@ Parameters:
 - `apiKey` (string): Your ScrapeGraph AI API key
 - `requestId` (string): The request ID from the scrape response
 - `rating` (number): Rating score
-- `feedbackText` (string): Feedback message
+- `feedbackText` (string) (optional): Feedback message
 
 ## Error Handling
 
-All functions return JSON strings that you should parse. In case of errors, the response will include error details:
+All functions return javascript `Error` object with imformation. In case of errors, the response will include error details:
+
+// TODO error list
 
 ```javascript
 {
-  "error": "HTTP error occurred",
-  "message": "Error details",
-  "status_code": 400
+  "statusCode": 400,
+  "title": "HTTP error occurred"
+  "details": "Error details",
+  
 }
 ```