Starstruk Logo MarkStarstruk

v2.0.0

zhu-xlab/GlobalBuildingAtlasv2.0.0Dec 3, 2024by adbar

AI Summary

A major version update introducing type hinting and modernizing the extraction API by returning a Document object by default, while deprecating older Python versions and CLI arguments.

Key Highlights

  • Return Document class by default from bare_extraction()
  • Deprecate Python 3.6 and 3.7
  • Remove deprecated graphical user interface
  • Add type hinting throughout the codebase
  • Update CLI to use 'fast' instead of 'no_fallback'

Breaking Changes

  • Python 3.6 and 3.7 deprecated
  • bare_extraction() now returns Document class by default
  • bare_extraction() and extract(): 'no_fallback' deprecated, use 'fast' instead
  • fetch_url() argument 'decode' removed, use 'fetch_response' instead
  • Deprecated graphical user interface removed
  • Extraction parameter max_tree_size moved to settings.cfg
  • Enforce fixed list of output formats, deprecate -out on the CLI

New Features

  • Type hinting added for better code maintainability
  • CLI improvements: print URLs early and add exit codes
  • Robust encoding fixes for options.source
  • Metadata robustness improvements for URL extraction
  • Simplify code and extend test coverage

Full Release Notes

Breaking changes:
- Python 3.6 and 3.7 deprecated (#709)
- `bare_extraction()`:
   - now returns an instance of the `Document` class by default
   - `as_dict` deprecation warning → use `.as_dict()` method on return value (#730)
- `bare_extraction()` and `extract()`: `no_fallback` deprecation warning → use `fast` instead (#730)
- downloads: remove `decode` argument in `fetch_url()` → use `fetch_response` instead (#724)
- deprecated graphical user interface now removed (#713)
- extraction: move `max_tree_size` parameter to `settings.cfg` (#742)
- use type hinting (#721, #723, #748)
- see [Python](https://trafilatura.readthedocs.io/en/latest/usage-python.html#deprecations) and [CLI](https://trafilatura.readthedocs.io/en/latest/usage-cli.html#deprecations) deprecations in the docs

Fixes:
- set `options.source` before raising error on empty doc tree by @dmoklaf (#707)
- robust encoding in `options.source` (#717)
- more robust mapping for conversion to HTML (#721)
- CLI downloads: use all information in settings file (#734)
- downloads: cleaner urllib3 code (#736)
- refine table markdown output by @unsleepy22 (#752)
- extraction fix: images in text nodes by @unsleepy22 (#757)

Metadata:
- more robust URL extraction (#710)

Command-line interface:
- CLI: print URLs early for feeds and sitemaps with `--list` with @gremid (#744)
- CLI: add 126 exit code for high error ratio (#747)

Maintenance:
- remove already deprecated functions and args (#716)
- add type hints (#723, #728)
- setup: use `pyproject.toml` file (#715)
- simplify code (#708, #709, #727)
- better debug messages in `main_extractor` (#714)
- evaluation: review data, update packages, add magic_html (#731)
- setup: explicit exports through `__all__` (#740)
- tests: extend coverage (#753)

Documentation:
- fix link in `docs/index.html` by @nzw0301 (#711)
- remove docs from published packages (#743)
- update docs (#745)