Showing the changes to apps/python-sdk (2 of 6 files). Show all
Unified · Split
| @@ -0,0 +1,21 @@ | |||
| 1 | MIT License | ||
| 2 | |||
| 3 | Copyright (c) 2024 Sideguide Technologies Inc. | ||
| 4 | |||
| 5 | Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| 6 | of this software and associated documentation files (the "Software"), to deal | ||
| 7 | in the Software without restriction, including without limitation the rights | ||
| 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| 9 | copies of the Software, and to permit persons to whom the Software is | ||
| 10 | furnished to do so, subject to the following conditions: | ||
| 11 | |||
| 12 | The above copyright notice and this permission notice shall be included in all | ||
| 13 | copies or substantial portions of the Software. | ||
| 14 | |||
| 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| 21 | SOFTWARE. | ||
| @@ -15,7 +15,6 @@ pip install firecrawl-py · 14 unmodified lines | |||
| 15 | 1. Get an API key from [firecrawl.dev](https://firecrawl.dev) | 15 | 1. Get an API key from [firecrawl.dev](https://firecrawl.dev) |
| 16 | 2. Set the API key as an environment variable named `FIRECRAWL_API_KEY` or pass it as a parameter to the `FirecrawlApp` class. | 16 | 2. Set the API key as an environment variable named `FIRECRAWL_API_KEY` or pass it as a parameter to the `FirecrawlApp` class. |
| 17 | 17 | ||
| 18 | |||
| 19 | Here's an example of how to use the SDK: | 18 | Here's an example of how to use the SDK: |
| 20 | 19 | ||
| 21 | ```python | 20 | ```python |
| @@ -46,6 +45,7 @@ To scrape a single URL, use the `scrape_url` method. It takes the URL as a param · 24 unmodified lines | |||
| 46 | url = 'https://example.com' | 45 | url = 'https://example.com' |
| 47 | scraped_data = app.scrape_url(url) | 46 | scraped_data = app.scrape_url(url) |
| 48 | ``` | 47 | ``` |
| 48 | |||
| 49 | ### Extracting structured data from a URL | 49 | ### Extracting structured data from a URL |
| 50 | 50 | ||
| 51 | With LLM extraction, you can easily extract structured data from any URL. We support pydantic schemas to make it easier for you too. Here is how you to use it: | 51 | With LLM extraction, you can easily extract structured data from any URL. We support pydantic schemas to make it easier for you too. Here is how you to use it: |
| @@ -53,7 +53,7 @@ With LLM extraction, you can easily extract structured data from any URL. We sup · 1 unmodified line | |||
| 53 | ```python | 53 | ```python |
| 54 | class ArticleSchema(BaseModel): | 54 | class ArticleSchema(BaseModel): |
| 55 | title: str | 55 | title: str |
| 56 | points: int | 56 | points: int |
| 57 | by: str | 57 | by: str |
| 58 | commentsURL: str | 58 | commentsURL: str |
| 59 | 59 | ||
| @@ -126,20 +126,27 @@ To ensure the functionality of the Firecrawl Python SDK, we have included end-to · 66 unmodified lines | |||
| 126 | To run the tests, execute the following commands: | 126 | To run the tests, execute the following commands: |
| 127 | 127 | ||
| 128 | Install pytest: | 128 | Install pytest: |
| 129 | |||
| 129 | ```bash | 130 | ```bash |
| 130 | pip install pytest | 131 | pip install pytest |
| 131 | ``` | 132 | ``` |
| 132 | 133 | ||
| 133 | Run: | 134 | Run: |
| 135 | |||
| 134 | ```bash | 136 | ```bash |
| 135 | pytest firecrawl/__tests__/e2e_withAuth/test.py | 137 | pytest firecrawl/__tests__/e2e_withAuth/test.py |
| 136 | ``` | 138 | ``` |
| 137 | 139 | ||
| 138 | |||
| 139 | ## Contributing | 140 | ## Contributing |
| 140 | 141 | ||
| 141 | Contributions to the Firecrawl Python SDK are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request on the GitHub repository. | 142 | Contributions to the Firecrawl Python SDK are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request on the GitHub repository. |
| 142 | 143 | ||
| 143 | ## License | 144 | ## License |
| 144 | 145 | ||
| 145 | The Firecrawl Python SDK is open-source and released under the [AGPL License](https://www.gnu.org/licenses/agpl-3.0.en.html). | 146 | The Firecrawl Python SDK is licensed under the MIT License. This means you are free to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the SDK, subject to the following conditions: |
| 147 | |||
| 148 | - The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | ||
| 149 | |||
| 150 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
| 151 | |||
| 152 | Please note that while this SDK is MIT licensed, it is part of a larger project which may be under different licensing terms. Always refer to the license information in the root directory of the main project for overall licensing details. | ||