Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
55a7f42
feat(v2): add zod schemas and types for v2 API
FrancescoSaverioZuppichini Apr 14, 2026
97a8958
feat(v2): implement SDK with crawl and monitor namespaces
FrancescoSaverioZuppichini Apr 14, 2026
5847b95
refactor: inline namespace functions directly in objects
FrancescoSaverioZuppichini Apr 14, 2026
a725c1c
fix: use deleted status and move types to src/types.ts
FrancescoSaverioZuppichini Apr 14, 2026
11b811c
feat(v2): rewrite tests for v2 API
FrancescoSaverioZuppichini Apr 14, 2026
8f44af9
test: add comprehensive tests for formats, fetchConfig, and document …
FrancescoSaverioZuppichini Apr 14, 2026
13578aa
refactor: rename getHistory/getHistoryEntry to history.list/history.get
FrancescoSaverioZuppichini Apr 14, 2026
6844d33
chore: split unit and integration tests for CI
FrancescoSaverioZuppichini Apr 14, 2026
d71e4d9
docs: update examples for v2 API
FrancescoSaverioZuppichini Apr 14, 2026
e30cc55
docs: rewrite README for v2 API
FrancescoSaverioZuppichini Apr 14, 2026
c9153e4
fix: address code smells in examples and README
FrancescoSaverioZuppichini Apr 14, 2026
22b936e
docs: use local banner from media folder
FrancescoSaverioZuppichini Apr 14, 2026
b5926d1
fix: remove hardcoded API key from integration tests
FrancescoSaverioZuppichini Apr 14, 2026
46bed0e
fix: add node types to tsconfig
FrancescoSaverioZuppichini Apr 14, 2026
276713b
chore: remove .claude and CLAUDE.md, add to gitignore
FrancescoSaverioZuppichini Apr 14, 2026
0738786
minor changes
FrancescoSaverioZuppichini Apr 14, 2026
3703f8c
docs: reorganize examples table by service, add SGAI_API_KEY env var
FrancescoSaverioZuppichini Apr 14, 2026
33ea3e6
feat: add ScrapeGraphAI client pattern, remove generateSchema
FrancescoSaverioZuppichini Apr 14, 2026
0522abc
test: update integration tests to use ScrapeGraphAI client
FrancescoSaverioZuppichini Apr 14, 2026
7c7d31c
chore: ignore scripts directory
FrancescoSaverioZuppichini Apr 14, 2026
d4bad81
chore: bump version to 2.0.0
FrancescoSaverioZuppichini Apr 14, 2026
b9037f5
docs: update CONTRIBUTING.md for JS SDK
FrancescoSaverioZuppichini Apr 14, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions .claude/commands/gh-pr.md

This file was deleted.

187 changes: 0 additions & 187 deletions .claude/skills/gh-pr.md

This file was deleted.

4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
scripts/
node_modules
dist/
.DS_Store
bun.lock
*.tsbuildinfo
.env
doc/
.DS_Store
.claude/
CLAUDE.md
104 changes: 39 additions & 65 deletions CONTRIBUTING.MD
Original file line number Diff line number Diff line change
@@ -1,83 +1,57 @@
# Contributing to ScrapeGraphAI
# Contributing to scrapegraph-js

Thank you for your interest in contributing to **ScrapeGraphAI**! We welcome contributions from the community to help improve and grow the project. This document outlines the guidelines and steps for contributing.
## Setup

## Table of Contents
```bash
bun install
```

- [Getting Started](#getting-started)
- [Contributing Guidelines](#contributing-guidelines)
- [Code Style](#code-style)
- [Submitting a Pull Request](#submitting-a-pull-request)
- [Reporting Issues](#reporting-issues)
- [License](#license)
## Development

## Getting Started
```bash
bun run build # build to dist/
bun run check # tsc + biome lint
```

To get started with contributing, follow these steps:
## Before committing

1. Fork the repository on GitHub **(FROM pre/beta branch)**.
2. Clone your forked repository to your local machine.
3. Install the necessary dependencies from requirements.txt or via pyproject.toml as you prefere :).
4. Make your changes or additions.
5. Test your changes thoroughly.
6. Commit your changes with descriptive commit messages.
7. Push your changes to your forked repository.
8. Submit a pull request to the pre/beta branch.
Run all checks:

N.B All the pull request to the main branch will be rejected!
```bash
bun run format # auto-fix formatting
bun run lint # check for errors
bunx tsc --noEmit # type check
bun run build # verify build
bun test # unit tests
```

## Contributing Guidelines
## Testing

Please adhere to the following guidelines when contributing to ScrapeGraphAI:
```bash
bun test # unit tests only
bun run test:integration # live API tests (requires SGAI_API_KEY)
```

- Follow the code style and formatting guidelines specified in the [Code Style](#code-style) section.
- Make sure your changes are well-documented and include any necessary updates to the project's documentation and requirements if needed.
- Write clear and concise commit messages that describe the purpose of your changes and the last commit before the pull request has to follow the following format:
- `feat: Add new feature`
- `fix: Correct issue with existing feature`
- `docs: Update documentation`
- `style: Improve formatting and style`
- `refactor: Restructure code`
- `test: Add or update tests`
- `perf: Improve performance`
- Be respectful and considerate towards other contributors and maintainers.
For integration tests, set `SGAI_API_KEY` in your environment or `.env` file.

## Code Style
## Commit messages

Please make sure to format your code accordingly before submitting a pull request.
Use conventional commits:

### Python
- `feat:` new feature
- `fix:` bug fix
- `refactor:` code change (no new feature, no bug fix)
- `chore:` maintenance (deps, config)
- `test:` add/update tests
- `docs:` documentation

- [Style Guide for Python Code](https://www.python.org/dev/peps/pep-0008/)
- [Google Python Style Guide](https://google.github.io/styleguide/pyguide.html)
- [The Hitchhiker's Guide to Python](https://docs.python-guide.org/writing/style/)
- [Pylint style of code for the documentation](https://pylint.pycqa.org/en/1.6.0/tutorial.html)
## Pull requests

## Submitting a Pull Request

To submit your changes for review, please follow these steps:

1. Ensure that your changes are pushed to your forked repository.
2. Go to the main repository on GitHub and navigate to the "Pull Requests" tab.
3. Click on the "New Pull Request" button.
4. Select your forked repository and the branch containing your changes.
5. Provide a descriptive title and detailed description for your pull request.
6. Reviewers will provide feedback and discuss any necessary changes.
7. Once your pull request is approved, it will be merged into the pre/beta branch.

## Reporting Issues

If you encounter any issues or have suggestions for improvements, please open an issue on the GitHub repository. Provide a clear and detailed description of the problem or suggestion, along with any relevant information or steps to reproduce the issue.
1. Fork and create a branch from `main`
2. Make changes
3. Run all checks (see above)
4. Submit PR to `main`

## License

ScrapeGraphAI is licensed under the **MIT License**. See the [LICENSE](LICENSE) file for more information.
By contributing to this project, you agree to license your contributions under the same license.

ScrapeGraphAI uses code from the Langchain
frameworks. You find their original licenses below.

LANGCHAIN LICENSE
https://github.com/langchain-ai/langchain/blob/master/LICENSE

Can't wait to see your contributions! :smile:
MIT - contributions are licensed under the same license.
Loading
Loading