From b3408c6f3c70eb8672c4178a55918ec567e2dad1 Mon Sep 17 00:00:00 2001 From: Karim shoair Date: Sun, 7 Jun 2026 16:44:18 +0300 Subject: [PATCH] docs: warn that the default installation doesn't include fetchers The quickstart examples import from `scrapling.fetchers`, which raises `ModuleNotFoundError` on a bare install since those dependencies live in the fetchers extra. Make the consequence explicit in the installation section across the docs and all README translations. Closes #343 --- README.md | 3 ++- docs/README_AR.md | 3 ++- docs/README_CN.md | 3 ++- docs/README_DE.md | 3 ++- docs/README_ES.md | 3 ++- docs/README_FR.md | 3 ++- docs/README_JP.md | 3 ++- docs/README_KR.md | 3 ++- docs/README_PT_BR.md | 3 ++- docs/README_RU.md | 3 ++- docs/index.md | 4 +++- 11 files changed, 23 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 4507844..e888c46 100644 --- a/README.md +++ b/README.md @@ -471,7 +471,8 @@ Scrapling requires Python 3.10 or higher: pip install scrapling ``` -This installation only includes the parser engine and its dependencies, without any fetchers or commandline dependencies. +> [!IMPORTANT] +> This installation only includes the parser engine and its dependencies, without any fetchers or commandline dependencies. So importing anything from `scrapling.fetchers` or `scrapling.spiders`, like in the examples above, will raise `ModuleNotFoundError` with this installation alone. If you are going to use any of the fetchers or spiders, install the fetchers' dependencies first as shown below. ### Optional Dependencies diff --git a/docs/README_AR.md b/docs/README_AR.md index 2070bc9..fdc5990 100644 --- a/docs/README_AR.md +++ b/docs/README_AR.md @@ -467,7 +467,8 @@ Scrapling ليس قوياً فحسب - بل هو أيضاً سريع بشكل م pip install scrapling ``` -يتضمن هذا التثبيت فقط محرك المحلل وتبعياته، بدون أي جوالب أو تبعيات سطر الأوامر. +> [!IMPORTANT] +> يتضمن هذا التثبيت فقط محرك المحلل وتبعياته، بدون أي جوالب أو تبعيات سطر الأوامر. لذلك، فإن استيراد أي شيء من `scrapling.fetchers` أو `scrapling.spiders`، كما في الأمثلة أعلاه، سيؤدي إلى خطأ `ModuleNotFoundError` مع هذا التثبيت وحده. إذا كنت ستستخدم أيًا من الجوالب أو العناكب، فقم أولًا بتثبيت تبعيات الجوالب كما هو موضح أدناه. ### التبعيات الاختيارية diff --git a/docs/README_CN.md b/docs/README_CN.md index 0750bcc..02c7415 100644 --- a/docs/README_CN.md +++ b/docs/README_CN.md @@ -467,7 +467,8 @@ Scrapling 需要 Python 3.10 或更高版本： pip install scrapling ``` -此安装仅包括解析器引擎及其依赖项，没有任何 Fetcher 或命令行依赖项。 +> [!IMPORTANT] +> 此安装仅包括解析器引擎及其依赖项，没有任何 Fetcher 或命令行依赖项。 因此，仅使用此安装时，像上面的示例那样从 `scrapling.fetchers` 或 `scrapling.spiders` 导入任何内容都会引发 `ModuleNotFoundError`。如果要使用任何 Fetcher 或 Spider，请先按照下面的说明安装 Fetcher 的依赖项。 ### 可选依赖项 diff --git a/docs/README_DE.md b/docs/README_DE.md index ac6e533..e4e320b 100644 --- a/docs/README_DE.md +++ b/docs/README_DE.md @@ -467,7 +467,8 @@ Scrapling erfordert Python 3.10 oder höher: pip install scrapling ``` -Diese Installation enthält nur die Parser-Engine und ihre Abhängigkeiten, ohne Fetcher oder Kommandozeilenabhängigkeiten. +> [!IMPORTANT] +> Diese Installation enthält nur die Parser-Engine und ihre Abhängigkeiten, ohne Fetcher oder Kommandozeilenabhängigkeiten. Daher führt der Import von allem aus `scrapling.fetchers` oder `scrapling.spiders`, wie in den Beispielen oben, mit dieser Installation allein zu einem `ModuleNotFoundError`. Wenn Sie einen der Fetcher oder Spider verwenden möchten, installieren Sie zuerst die Fetcher-Abhängigkeiten wie unten gezeigt. ### Optionale Abhängigkeiten diff --git a/docs/README_ES.md b/docs/README_ES.md index 1af1f9a..2105dd8 100644 --- a/docs/README_ES.md +++ b/docs/README_ES.md @@ -467,7 +467,8 @@ Scrapling requiere Python 3.10 o superior: pip install scrapling ``` -Esta instalación solo incluye el motor de análisis y sus dependencias, sin ningún fetcher ni dependencias de línea de comandos. +> [!IMPORTANT] +> Esta instalación solo incluye el motor de análisis y sus dependencias, sin ningún fetcher ni dependencias de línea de comandos. Por lo tanto, importar cualquier cosa desde `scrapling.fetchers` o `scrapling.spiders`, como en los ejemplos anteriores, lanzará un `ModuleNotFoundError` solo con esta instalación. Si va a usar alguno de los fetchers o spiders, instale primero las dependencias de los fetchers como se muestra a continuación. ### Dependencias Opcionales diff --git a/docs/README_FR.md b/docs/README_FR.md index c6d76ed..55a122c 100644 --- a/docs/README_FR.md +++ b/docs/README_FR.md @@ -467,7 +467,8 @@ Scrapling nécessite Python 3.10 ou supérieur : pip install scrapling ``` -Cette installation n'inclut que le moteur de parsing et ses dépendances, sans aucun fetcher ni dépendance en ligne de commande. +> [!IMPORTANT] +> Cette installation n'inclut que le moteur de parsing et ses dépendances, sans aucun fetcher ni dépendance en ligne de commande. Importer quoi que ce soit depuis `scrapling.fetchers` ou `scrapling.spiders`, comme dans les exemples ci-dessus, lèvera donc une `ModuleNotFoundError` avec cette seule installation. Si vous comptez utiliser l'un des fetchers ou spiders, installez d'abord les dépendances des fetchers comme indiqué ci-dessous. ### Dépendances optionnelles diff --git a/docs/README_JP.md b/docs/README_JP.md index dcf44fc..e57a0b5 100644 --- a/docs/README_JP.md +++ b/docs/README_JP.md @@ -467,7 +467,8 @@ Scrapling には Python 3.10 以上が必要です： pip install scrapling ``` -このインストールにはパーサーエンジンとその依存関係のみが含まれており、Fetcher やコマンドライン依存関係は含まれていません。 +> [!IMPORTANT] +> このインストールにはパーサーエンジンとその依存関係のみが含まれており、Fetcher やコマンドライン依存関係は含まれていません。 そのため、このインストールのみでは、上記の例のように `scrapling.fetchers` や `scrapling.spiders` から何かをインポートすると `ModuleNotFoundError` が発生します。Fetcher や Spider を使用する場合は、以下のように、まず Fetcher の依存関係をインストールしてください。 ### オプションの依存関係 diff --git a/docs/README_KR.md b/docs/README_KR.md index 18d2e05..f5c913b 100644 --- a/docs/README_KR.md +++ b/docs/README_KR.md @@ -467,7 +467,8 @@ Scrapling은 Python 3.10 이상이 필요합니다: pip install scrapling ``` -이 설치에는 파서 엔진과 의존성만 포함되며, Fetcher나 커맨드라인 의존성은 포함되지 않습니다. +> [!IMPORTANT] +> 이 설치에는 파서 엔진과 의존성만 포함되며, Fetcher나 커맨드라인 의존성은 포함되지 않습니다. 따라서 이 설치만으로는 위 예제처럼 `scrapling.fetchers`나 `scrapling.spiders`에서 무언가를 임포트하면 `ModuleNotFoundError`가 발생합니다. Fetcher나 Spider를 사용하려면 아래와 같이 먼저 Fetcher 의존성을 설치하세요. ### 선택적 의존성 diff --git a/docs/README_PT_BR.md b/docs/README_PT_BR.md index 4c7f617..3884614 100644 --- a/docs/README_PT_BR.md +++ b/docs/README_PT_BR.md @@ -469,7 +469,8 @@ O Scrapling requer Python 3.10 ou superior: pip install scrapling ``` -Esta instalação inclui apenas o motor de parsing e suas dependências, sem fetchers nem dependências de linha de comando. +> [!IMPORTANT] +> Esta instalação inclui apenas o motor de parsing e suas dependências, sem fetchers nem dependências de linha de comando. Portanto, importar qualquer coisa de `scrapling.fetchers` ou `scrapling.spiders`, como nos exemplos acima, lançará um `ModuleNotFoundError` apenas com esta instalação. Se você for usar algum dos fetchers ou spiders, instale primeiro as dependências dos fetchers como mostrado abaixo. ### Dependências Opcionais diff --git a/docs/README_RU.md b/docs/README_RU.md index 4dde2b9..ba5bb31 100644 --- a/docs/README_RU.md +++ b/docs/README_RU.md @@ -470,7 +470,8 @@ Scrapling требует Python 3.10 или выше: pip install scrapling ``` -Эта установка включает только движок парсера и его зависимости, без каких-либо Fetcher'ов или зависимостей командной строки. +> [!IMPORTANT] +> Эта установка включает только движок парсера и его зависимости, без каких-либо Fetcher'ов или зависимостей командной строки. Поэтому импорт чего-либо из `scrapling.fetchers` или `scrapling.spiders`, как в примерах выше, вызовет `ModuleNotFoundError` при такой установке. Если вы собираетесь использовать какие-либо Fetcher'ы или Spider'ы, сначала установите зависимости Fetcher'ов, как показано ниже. ### Опциональные зависимости diff --git a/docs/index.md b/docs/index.md index fdae518..b5a8ba4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -180,7 +180,9 @@ Scrapling requires Python 3.10 or higher: pip install scrapling ``` -This installation only includes the parser engine and its dependencies, without any fetchers or commandline dependencies. +!!! warning + + This installation only includes the parser engine and its dependencies, without any fetchers or commandline dependencies. So importing anything from `scrapling.fetchers` or `scrapling.spiders`, like in the examples above, will raise `ModuleNotFoundError` with this installation alone. If you are going to use any of the fetchers or spiders, install the fetchers' dependencies first as shown below. ### Optional Dependencies