wxpath 0.2.0__tar.gz → 0.4.0__tar.gz

{wxpath-0.2.0/src/wxpath.egg-info → wxpath-0.4.0}/PKG-INFO

@@ -1,16 +1,22 @@
 Metadata-Version: 2.4
 Name: wxpath
-Version: 0.2.0
+Version: 0.4.0
 Summary: wxpath - a declarative web crawler and data extractor
 Author-email: Rodrigo Palacios <rodrigopala91@gmail.com>
 License-Expression: MIT
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: requests>=2.0
 Requires-Dist: lxml>=4.0
 Requires-Dist: elementpath<=5.0.3,>=5.0.0
 Requires-Dist: aiohttp<=3.12.15,>=3.8.0
+Requires-Dist: tqdm>=4.0.0
+Provides-Extra: cache
+Requires-Dist: aiohttp-client-cache>=0.14.0; extra == "cache"
+Provides-Extra: cache-sqlite
+Requires-Dist: aiohttp-client-cache[sqlite]; extra == "cache-sqlite"
+Provides-Extra: cache-redis
+Requires-Dist: aiohttp-client-cache[redis]; extra == "cache-redis"
 Provides-Extra: test
 Requires-Dist: pytest>=7.0; extra == "test"
 Requires-Dist: pytest-asyncio>=0.23; extra == "test"
@@ -18,12 +24,13 @@ Provides-Extra: dev
 Requires-Dist: ruff; extra == "dev"
 Dynamic: license-file
 
+# **wxpath** - declarative web crawling with XPath 
 
-# wxpath - declarative web crawling with XPath
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/release/python-3100/)
 
-**wxpath** is a declarative web crawler where traversal is expressed directly in XPath. Instead of writing imperative crawl loops, you describe what to follow and what to extract in a single expression. **wxpath** evaluates that expression concurrently, breadth-first-*ish*, and streams results as they are discovered.
+**wxpath** is a declarative web crawler where traversal is expressed directly in XPath. Instead of writing imperative crawl loops, wxpath lets you describe what to follow and what to extract in a single expression. **wxpath** executes that expression concurrently, breadth-first-*ish*, and streams results as they are discovered.
 
-By introducing the `url(...)` operator and the `///` syntax, **wxpath**'s engine is able to perform deep, recursive web crawling and extraction.
+By introducing the `url(...)` operator and the `///` syntax, wxpath's engine is able to perform deep (or paginated) web crawling and extraction.
 
 NOTE: This project is in early development. Core concepts are stable, but the API and features may change. Please report issues - in particular, deadlocked crawls or unexpected behavior - and any features you'd like to see (no guarantee they'll be implemented).
 
@@ -31,19 +38,26 @@ NOTE: This project is in early development. Core concepts are stable, but the AP
 ## Contents
 
 - [Example](#example)
-- [`url(...)` and `///url(...)` Explained](#url-and---explained)
+- [Language Design](DESIGN.md)
+- [`url(...)` and `///url(...)` Explained](#url-and-url-explained)
 - [General flow](#general-flow)
 - [Asynchronous Crawling](#asynchronous-crawling)
+- [Polite Crawling](#polite-crawling)
 - [Output types](#output-types)
-- [XPath 3.1 support](#xpath-31-support)
+- [XPath 3.1](#xpath-31-by-default)
+- [Progress Bar](#progress-bar)
 - [CLI](#cli)
+- [Persistence and Caching](#persistence-and-caching)
+- [Settings](#settings)
 - [Hooks (Experimental)](#hooks-experimental)
 - [Install](#install)
-- [More Examples](#more-examples)
+- [More Examples](EXAMPLES.md)
 - [Comparisons](#comparisons)
 - [Advanced: Engine & Crawler Configuration](#advanced-engine--crawler-configuration)
 - [Project Philosophy](#project-philosophy)
 - [Warnings](#warnings)
+- [Commercial support / consulting](#commercial-support--consulting)
+- [Versioning](#versioning)
 - [License](#license)
 
 
@@ -51,34 +65,40 @@ NOTE: This project is in early development. Core concepts are stable, but the AP
 
 ```python
 import wxpath
+from wxpath.settings import CRAWLER_SETTINGS
 
-path = """
+# Custom headers for politeness; necessary for some sites (e.g., Wikipedia)
+CRAWLER_SETTINGS.headers = {'User-Agent': 'my-app/0.4.0 (contact: you@example.com)'}
+
+# Crawl, extract fields, build a knowledge graph
+path_expr = """
 url('https://en.wikipedia.org/wiki/Expression_language')
- ///url(//main//a/@href[starts-with(., '/wiki/') and not(contains(., ':'))])
- /map{
-    'title':(//span[contains(@class, "mw-page-title-main")]/text())[1],
-    'url':string(base-uri(.)),
-    'short_description':(//div[contains(@class, 'shortdescription')]/text())[1]
- }
+  ///url(//main//a/@href[starts-with(., '/wiki/') and not(contains(., ':'))])
+    /map{
+        'title': (//span[contains(@class, "mw-page-title-main")]/text())[1] ! string(.),
+        'url': string(base-uri(.)),
+        'short_description': //div[contains(@class, 'shortdescription')]/text() ! string(.),
+        'forward_links': //div[@id="mw-content-text"]//a/@href ! string(.)
+    }
 """
 
-for item in wxpath.wxpath_async_blocking_iter(path, max_depth=1):
+for item in wxpath.wxpath_async_blocking_iter(path_expr, max_depth=1):
     print(item)
 ```
 
 Output:
 
 ```python
-map{'title': TextNode('Computer language'), 'url': 'https://en.wikipedia.org/wiki/Computer_language', 'short_description': TextNode('Formal language for communicating with a computer')}
-map{'title': TextNode('Machine-readable medium and data'), 'url': 'https://en.wikipedia.org/wiki/Machine_readable', 'short_description': TextNode('Medium capable of storing data in a format readable by a machine')}
-map{'title': TextNode('Advanced Boolean Expression Language'), 'url': 'https://en.wikipedia.org/wiki/Advanced_Boolean_Expression_Language', 'short_description': TextNode('Hardware description language and software')}
-map{'title': TextNode('Jakarta Expression Language'), 'url': 'https://en.wikipedia.org/wiki/Jakarta_Expression_Language', 'short_description': TextNode('Computer programming language')}
-map{'title': TextNode('Data Analysis Expressions'), 'url': 'https://en.wikipedia.org/wiki/Data_Analysis_Expressions', 'short_description': TextNode('Formula and data query language')}
-map{'title': TextNode('Domain knowledge'), 'url': 'https://en.wikipedia.org/wiki/Domain_knowledge', 'short_description': TextNode('Specialist knowledge within a specific field')}
-map{'title': TextNode('Rights Expression Language'), 'url': 'https://en.wikipedia.org/wiki/Rights_Expression_Language', 'short_description': TextNode('Machine-processable language used to express intellectual property rights (such as copyright)')}
-map{'title': TextNode('Computer science'), 'url': 'https://en.wikipedia.org/wiki/Computer_science', 'short_description': TextNode('Study of computation')}
+map{'title': 'Computer language', 'url': 'https://en.wikipedia.org/wiki/Computer_language', 'short_description': 'Formal language for communicating with a computer', 'forward_links': ['/wiki/Formal_language', '/wiki/Communication', ...]}
+map{'title': 'Advanced Boolean Expression Language', 'url': 'https://en.wikipedia.org/wiki/Advanced_Boolean_Expression_Language', 'short_description': 'Hardware description language and software', 'forward_links': ['/wiki/File:ABEL_HDL_example_SN74162.png', '/wiki/Hardware_description_language', ...]}
+map{'title': 'Machine-readable medium and data', 'url': 'https://en.wikipedia.org/wiki/Machine_readable', 'short_description': 'Medium capable of storing data in a format readable by a machine', 'forward_links': ['/wiki/File:EAN-13-ISBN-13.svg', '/wiki/ISBN', ...]}
+...
 ```
 
+**Note:** Some sites (including Wikipedia) may block requests without proper headers.  
+See [Advanced: Engine & Crawler Configuration](#advanced-engine--crawler-configuration) to set a custom `User-Agent`.
+
+
 The above expression does the following:
 
 1. Starts at the specified URL, `https://en.wikipedia.org/wiki/Expression_language`.
@@ -92,18 +112,23 @@ The above expression does the following:
 ## `url(...)` and `///url(...)` Explained
 
 - `url(...)` is a custom operator that fetches the content of the user-specified or internally generated URL and returns it as an `lxml.html.HtmlElement` for further XPath processing.
-- `///url(...)` indicates infinite/recursive traversal. It tells **wxpath** to continue following links indefinitely, up to the specified `max_depth`. Unlike repeated `url()` hops, it allows a single expression to describe unbounded graph exploration. WARNING: Use with caution and constraints (via `max_depth` or XPath predicates) to avoid traversal explosion.
+- `///url(...)` indicates a deep crawl. It tells the runtime engine to continue following links up to the specified `max_depth`. Unlike repeated `url()` hops, it allows a single expression to describe deeper graph exploration. WARNING: Use with caution and constraints (via `max_depth` or XPath predicates) to avoid traversal explosion.
+
+
+## Language Design
+
+See [DESIGN.md](DESIGN.md) for details of the language design. You will see the core concepts and design the language from the ground up.
 
 
 ## General flow
 
 **wxpath** evaluates an expression as a list of traversal and extraction steps (internally referred to as `Segment`s).
 
-`url(...)` creates crawl tasks either statically (via a fixed URL) or dynamically (via a URL derived from the XPath expression). **URLs are deduplicated globally, not per-depth and on a best-effort basis**.
+`url(...)` creates crawl tasks either statically (via a fixed URL) or dynamically (via a URL derived from the XPath expression). **URLs are deduplicated globally, on a best-effort basis - not per-depth**.
 
 XPath segments operate on fetched documents (fetched via the immediately preceding `url(...)` operations).
 
-`///url(...)` indicates infinite/recursive traversal - it proceeds breadth-first-*ish* up to `max_depth`.
+`///url(...)` indicates deep crawling - it proceeds breadth-first-*ish* up to `max_depth`.
 
 Results are yielded as soon as they are ready.
 
@@ -128,7 +153,7 @@ asyncio.run(main())
 
 ### Blocking, Concurrent Requests
 
-**wxpath** also supports concurrent requests using an asyncio-in-sync pattern, allowing you to crawl multiple pages concurrently while maintaining the simplicity of synchronous code. This is particularly useful for crawls in strictly synchronous execution environments (i.e., not inside an `asyncio` event loop) where performance is a concern.
+**wxpath** also provides an asyncio-in-sync API, allowing you to crawl multiple pages concurrently while maintaining the simplicity of synchronous code. This is particularly useful for crawls in strictly synchronous execution environments (i.e., not inside an `asyncio` event loop) where performance is a concern.
 
 ```python
 from wxpath import wxpath_async_blocking_iter
@@ -137,10 +162,14 @@ path_expr = "url('https://en.wikipedia.org/wiki/Expression_language')///url(//@h
 items = list(wxpath_async_blocking_iter(path_expr, max_depth=1))
 ```
 
+## Polite Crawling
+
+**wxpath** respects [robots.txt](https://en.wikipedia.org/wiki/Robots_exclusion_standard) by default via the `WXPathEngine(..., robotstxt=True)` constructor.
+
 
 ## Output types
 
-The wxpath Python API yields structured objects, not just strings.
+The wxpath Python API yields structured objects.
 
 Depending on the expression, results may include:
 
@@ -181,6 +210,17 @@ path_expr = """
 # ...]
 ```
 
+## Progress Bar
+
+**wxpath** provides a progress bar (via `tqdm`) to track crawl progress. This is especially useful for long-running crawls.
+
+Enable by setting `engine.run(..., progress=True)`, or pass `progress=True` to any of the `wxpath_async*(...)` functions.
+
+```python
+items = wxpath.wxpath_async_blocking("...", progress=True)
+> 100%|██████████████████████████████████████████████████████████▎| 469/471 [00:05<00:00, 72.00it/s, depth=2, yielded=457]
+```
+
 
 ## CLI
 
@@ -188,10 +228,11 @@ path_expr = """
 
 The following example demonstrates how to crawl Wikipedia starting from the "Expression language" page, extract links to other wiki pages, and retrieve specific fields from each linked page.
 
-WARNING: Due to the everchanging nature of web content, the output may vary over time.
+NOTE: Due to the everchanging nature of web content, the output may vary over time.
 ```bash
-> wxpath --depth 1 "\
-    url('https://en.wikipedia.org/wiki/Expression_language')\
+> wxpath --depth 1 \
+    --header "User-Agent: my-app/0.1 (contact: you@example.com)" \
+    "url('https://en.wikipedia.org/wiki/Expression_language') \
     ///url(//div[@id='mw-content-text']//a/@href[starts-with(., '/wiki/') \
         and not(matches(@href, '^(?:/wiki/)?(?:Wikipedia|File|Template|Special|Template_talk|Help):'))]) \
     /map{ \
@@ -212,6 +253,55 @@ WARNING: Due to the everchanging nature of web content, the output may vary over
 {"title": "Computer science", "short_description": "Study of computation", "url": "https://en.wikipedia.org/wiki/Computer_science", "backlink": "https://en.wikipedia.org/wiki/Expression_language", "depth": 1.0}
 ```
 
+Command line options:
+
+```bash
+--depth                <depth>       Max crawl depth
+--verbose              [true|false]  Provides superficial CLI information
+--debug                [true|false]  Provides verbose runtime output and information
+--concurrency          <concurrency> Number of concurrent fetches
+--concurrency-per-host <concurrency> Number of concurrent fetches per host
+--header               "Key:Value"   Add a custom header (e.g., 'Key:Value'). Can be used multiple times.
+--respect-robots       [true|false] (Default: True) Respects robots.txt
+--cache                [true|false] (Default: False) Persist crawl results to a local database
+```
+
+
+## Persistence and Caching
+
+**wxpath** optionally persists crawl results to a local database. This is especially useful when you're crawling a large number of URLs, and you decide to pause the crawl, change extraction expressions, or otherwise need to restart the crawl. 
+
+**wxpath** supports two backends: sqlite and redis. SQLite is great for small-scale crawls, with a single worker (i.e., `engine.crawler.concurrency == 1`). Redis is great for large-scale crawls, with multiple workers. You will be encounter a warning if you `min(engine.crawler.concurrency, engine.crawler.per_host) > 1` when using the sqlite backend.
+
+To use, you must install the appropriate optional dependency:
+
+```bash
+pip install wxpath[cache-sqlite]
+pip install wxpath[cache-redis]
+```
+
+Once the dependency is installed, you must enable the cache:
+
+```python
+from wxpath.settings import SETTINGS
+
+# To enable caching; sqlite is the default
+SETTINGS.http.client.cache.enabled = True
+
+# For redis backend
+SETTINGS.http.client.cache.enabled = True
+SETTINGS.http.client.cache.backend = "redis"
+SETTINGS.http.client.cache.redis.address = "redis://localhost:6379/0"
+
+# Run wxpath as usual
+items = list(wxpath_async_blocking_iter('...', max_depth=1, engine=engine))
+```
+
+
+## Settings
+
+See [settings.py](src/wxpath/settings.py) for details of the settings.
+
 
 ## Hooks (Experimental)
 
@@ -257,10 +347,19 @@ hooks.register(hooks.JSONLWriter)
 
 ## Install
 
+Requires Python 3.10+.
+
 ```
 pip install wxpath
 ```
 
+For persisted/cached, wxpath supports the following backends:
+
+```
+pip install wxpath[cache-sqlite]
+pip install wxpath[cache-redis]
+```
+
 
 ## More Examples
 
@@ -285,13 +384,20 @@ crawler = Crawler(
     concurrency=8,
     per_host=2,
     timeout=10,
+    respect_robots=False,
+    headers={
+        "User-Agent": "my-app/0.1.0 (contact: you@example.com)", # Sites like Wikipedia will appreciate this
+    },
 )
 
 # If `crawler` is not specified, a default Crawler will be created with
-# the provided concurrency and per_host values, or with defaults.
+# the provided concurrency, per_host, and respect_robots values, or with defaults.
 engine = WXPathEngine(
-    # concurrency=16,
-    # per_host=8, 
+    # concurrency: int = 16, 
+    # per_host: int = 8,
+    # respect_robots: bool = True,
+    # allowed_response_codes: set[int] = {200},
+    # allow_redirects: bool = True,
     crawler=crawler,
 )
 
@@ -305,33 +411,50 @@ items = list(wxpath_async_blocking_iter(path_expr, max_depth=1, engine=engine))
 
 ### Principles
 
-- Enable declarative, recursive scraping without boilerplate
+- Enable declarative, crawling and scraping without boilerplate
 - Stay lightweight and composable
 - Asynchronous support for high-performance crawls
 
-### Guarantees/Goals
+### Goals
 
 - URLs are deduplicated on a best-effort, per-crawl basis.
 - Crawls are intended to terminate once the frontier is exhausted or `max_depth` is reached.
 - Requests are performed concurrently.
 - Results are streamed as soon as they are available.
 
-### Non-Goals/Limitations (for now)
+### Limitations (for now)
+
+The following features are not yet supported:
 
-- Strict result ordering
-- Persistent scheduling or crawl resumption
 - Automatic proxy rotation
 - Browser-based rendering (JavaScript execution)
+- Strict result ordering
 
 
 ## WARNINGS!!!
 
 - Be respectful when crawling websites. A scrapy-inspired throttler is enabled by default.
-- Recursive (`///`) crawls require user discipline to avoid unbounded expansion (traversal explosion).
+- Deep crawls (`///`) require user discipline to avoid unbounded expansion (traversal explosion).
 - Deadlocks and hangs are possible in certain situations (e.g., all tasks waiting on blocked requests). Please report issues if you encounter such behavior.
 - Consider using timeouts, `max_depth`, and XPath predicates and filters to limit crawl scope.
 
 
+## Commercial support / consulting
+
+If you want help building or operating crawlers/data feeds with wxpath (extraction, scheduling, monitoring, breakage fixes) or other web-scraping needs, please contact me at: rodrigopala91@gmail.com.
+
+
+### Donate
+
+If you like wxpath and want to support its development, please consider [donating](https://www.paypal.com/donate/?business=WDNDK6J6PJEXY&no_recurring=0&item_name=Thanks+for+using+wxpath%21+Donations+fund+development%2C+docs%2C+and+bug+fixes.+If+wxpath+saved+you+time%2C+a+small+contribution+helps%21&currency_code=USD).
+
+
+## Versioning
+
+**wxpath** follows [semver](https://semver.org): `<MAJOR>.<MINOR>.<PATCH>`.
+
+However, pre-1.0.0 follows `0.<MAJOR>.<MINOR|PATCH>`.
+
 ## License
 
 MIT