1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
========
web-poet
========
.. image:: https://img.shields.io/pypi/v/web-poet.svg
:target: https://pypi.python.org/pypi/web-poet
:alt: PyPI Version
.. image:: https://img.shields.io/pypi/pyversions/web-poet.svg
:target: https://pypi.python.org/pypi/web-poet
:alt: Supported Python Versions
.. image:: https://github.com/scrapinghub/web-poet/actions/workflows/tests-ubuntu.yml/badge.svg
:target: https://github.com/scrapinghub/web-poet/actions/workflows/tests-ubuntu.yml
:alt: Tox Ubuntu
.. image:: https://github.com/scrapinghub/web-poet/actions/workflows/tests-windows.yml/badge.svg
:target: https://github.com/scrapinghub/web-poet/actions/workflows/tests-windows.yml
:alt: Tox Windows
.. image:: https://codecov.io/github/scrapinghub/web-poet/coverage.svg?branch=master
:target: https://codecov.io/gh/scrapinghub/web-poet
:alt: Coverage report
.. image:: https://readthedocs.org/projects/web-poet/badge/?version=stable
:target: https://web-poet.readthedocs.io/en/stable/?badge=stable
:alt: Documentation Status
.. intro starts
``web-poet`` is a Python 3.10+ implementation of the `page object pattern`_ for
web scraping. It enables writing portable, reusable web parsing code.
.. _page object pattern: https://martinfowler.com/bliki/PageObject.html
.. intro ends
See the documentation_.
.. _documentation: https://web-poet.readthedocs.io
Developing
==========
Setup your local Python environment via:
1. `pip install -r requirements-dev.txt`
2. `pre-commit install`
Now everytime you perform a `git commit`, these tools will run against the
staged files:
* `black`
* `isort`
* `flake8`
You can also directly invoke `pre-commit run --all-files` or `tox -e linters`
to run them without performing a commit.
|
