You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Clarity of the pipeline documentation could be improved by more clearly calling out the steps that need to be taken to enable a custom pipeline. I was encouraged to issue this request in my Reddit thread where I was struggling to resolve this issue: thread.
To enable your media pipeline you must first add it to your project item pipeline setting.
For Images Pipeline, use:
ITEM_PIPELINES = {'scrapy.pipelines.images.ImagesPipeline': 1}
To me, it reads like "to use this custom pipeline, just add this line to your settings.py file". If the doc maintainers wanted to be more clear, it could have read "add this line to your item pipeline settings and replace these fields with the appropriate fields from your project", like I do below:
Improve clarity/readability, help newer users get up to speed more quickly.
Describe alternatives you've considered
on reddit /u/Gallaecio/ suggested the following as an alternative:
I think you might have a point. I bet something as simple as changing
scrapy.pipelines.images.ImagesPipeline to something like
my_project.pipelines.MyImagesPipeline would make things more obvious.
Either solution would help to show that 'scrapy' references the specific project you're working on, and 'ImagesPipeline' is the custom class you setup for your project.
Additional context
In my attempts to resolve my own problem I found many threads going back years on stack overflow and reddit that highlighted the same issue. I believe that the change would help new users avoid a potentially frustrating issue.
The text was updated successfully, but these errors were encountered:
Summary
Clarity of the pipeline documentation could be improved by more clearly calling out the steps that need to be taken to enable a custom pipeline. I was encouraged to issue this request in my Reddit thread where I was struggling to resolve this issue: thread.
Existing documentation:
https://docs.scrapy.org/en/latest/topics/media-pipeline.html
To me, it reads like "to use this custom pipeline, just add this line to your settings.py file". If the doc maintainers wanted to be more clear, it could have read "add this line to your item pipeline settings and replace these fields with the appropriate fields from your project", like I do below:
Motivation
Improve clarity/readability, help newer users get up to speed more quickly.
Describe alternatives you've considered
on reddit /u/Gallaecio/ suggested the following as an alternative:
Either solution would help to show that 'scrapy' references the specific project you're working on, and 'ImagesPipeline' is the custom class you setup for your project.
Additional context
In my attempts to resolve my own problem I found many threads going back years on stack overflow and reddit that highlighted the same issue. I believe that the change would help new users avoid a potentially frustrating issue.
The text was updated successfully, but these errors were encountered: