Skip to content

Commit b7f7b65

Browse files
committed
feat: add js package
0 parents  commit b7f7b65

85 files changed

Lines changed: 18140 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

AGENTIC_SCRAPER.md

Lines changed: 438 additions & 0 deletions
Large diffs are not rendered by default.

CODE_OF_CONDUCT.md

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
- Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
- The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
- Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
mvincig11@gmail.com.
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

CONTRIBUTING.MD

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Contributing to ScrapeGraphAI
2+
3+
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.
4+
5+
## Table of Contents
6+
7+
- [Getting Started](#getting-started)
8+
- [Contributing Guidelines](#contributing-guidelines)
9+
- [Code Style](#code-style)
10+
- [Submitting a Pull Request](#submitting-a-pull-request)
11+
- [Reporting Issues](#reporting-issues)
12+
- [License](#license)
13+
14+
## Getting Started
15+
16+
To get started with contributing, follow these steps:
17+
18+
1. Fork the repository on GitHub **(FROM pre/beta branch)**.
19+
2. Clone your forked repository to your local machine.
20+
3. Install the necessary dependencies from requirements.txt or via pyproject.toml as you prefere :).
21+
4. Make your changes or additions.
22+
5. Test your changes thoroughly.
23+
6. Commit your changes with descriptive commit messages.
24+
7. Push your changes to your forked repository.
25+
8. Submit a pull request to the pre/beta branch.
26+
27+
N.B All the pull request to the main branch will be rejected!
28+
29+
## Contributing Guidelines
30+
31+
Please adhere to the following guidelines when contributing to ScrapeGraphAI:
32+
33+
- Follow the code style and formatting guidelines specified in the [Code Style](#code-style) section.
34+
- Make sure your changes are well-documented and include any necessary updates to the project's documentation and requirements if needed.
35+
- 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:
36+
- `feat: Add new feature`
37+
- `fix: Correct issue with existing feature`
38+
- `docs: Update documentation`
39+
- `style: Improve formatting and style`
40+
- `refactor: Restructure code`
41+
- `test: Add or update tests`
42+
- `perf: Improve performance`
43+
- Be respectful and considerate towards other contributors and maintainers.
44+
45+
## Code Style
46+
47+
Please make sure to format your code accordingly before submitting a pull request.
48+
49+
### Python
50+
51+
- [Style Guide for Python Code](https://www.python.org/dev/peps/pep-0008/)
52+
- [Google Python Style Guide](https://google.github.io/styleguide/pyguide.html)
53+
- [The Hitchhiker's Guide to Python](https://docs.python-guide.org/writing/style/)
54+
- [Pylint style of code for the documentation](https://pylint.pycqa.org/en/1.6.0/tutorial.html)
55+
56+
## Submitting a Pull Request
57+
58+
To submit your changes for review, please follow these steps:
59+
60+
1. Ensure that your changes are pushed to your forked repository.
61+
2. Go to the main repository on GitHub and navigate to the "Pull Requests" tab.
62+
3. Click on the "New Pull Request" button.
63+
4. Select your forked repository and the branch containing your changes.
64+
5. Provide a descriptive title and detailed description for your pull request.
65+
6. Reviewers will provide feedback and discuss any necessary changes.
66+
7. Once your pull request is approved, it will be merged into the pre/beta branch.
67+
68+
## Reporting Issues
69+
70+
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.
71+
72+
## License
73+
74+
ScrapeGraphAI is licensed under the **MIT License**. See the [LICENSE](LICENSE) file for more information.
75+
By contributing to this project, you agree to license your contributions under the same license.
76+
77+
ScrapeGraphAI uses code from the Langchain
78+
frameworks. You find their original licenses below.
79+
80+
LANGCHAIN LICENSE
81+
https://github.com/langchain-ai/langchain/blob/master/LICENSE
82+
83+
Can't wait to see your contributions! :smile:

0 commit comments

Comments
 (0)