Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release notes for 0.26.0 #217

Merged
merged 1 commit into from
Jan 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@
Changelog
=========

0.26.0 (2025-01-DD)
-------------------

* Added an :ref:`add-on <addon>`.

0.25.0 (2024-12-27)
-------------------

Expand Down
31 changes: 28 additions & 3 deletions docs/intro/setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,22 @@ Setup

.. _intro-install:

Install from PyPI::
Install
=======

.. code-block:: bash
pip install scrapy-poet
Then configure:
- For Scrapy ≥ 2.10, install the add-on:
Enable
======

Add the following to your Scrapy configuration to enable scrapy-poet:

.. _addon:

- For Scrapy ≥ 2.10, configure the add-on:

.. code-block:: python
:caption: settings.py
Expand Down Expand Up @@ -54,3 +63,19 @@ Then configure:
SPIDER_MIDDLEWARES = {
"scrapy_poet.RetryMiddleware": 275,
}
Configure
=========

Declare the :setting:`SCRAPY_POET_DISCOVER` setting with a list of modules that
define page objects, so that they can be loaded at run-time.

A best practice is to create a ``pages/`` folder in your Scrapy project, a
sibling of your ``spiders/`` folder, add an empty ``__init__.py`` file to it
to make it a Python module, and declare its import path in the setting:

.. code-block:: python
:caption: settings.py
SCRAPY_POET_DISCOVER = ["myproject.pages"]
Loading