https://github.com/mzdm/beautiful_soup
Dart native package inspired by Beautiful Soup 4 Python library. Provides easy ways of navigating, searching, and modifying the HTML tree.
https://github.com/mzdm/beautiful_soup
Last synced: 2 months ago
JSON representation
Dart native package inspired by Beautiful Soup 4 Python library. Provides easy ways of navigating, searching, and modifying the HTML tree.
- Host: GitHub
- URL: https://github.com/mzdm/beautiful_soup
- Owner: mzdm
- License: mit
- Created: 2021-06-30T18:01:40.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-07-05T12:50:39.000Z (almost 3 years ago)
- Last Synced: 2025-03-17T19:52:08.595Z (3 months ago)
- Language: Dart
- Homepage: https://pub.dev/packages/beautiful_soup_dart
- Size: 87.9 KB
- Stars: 32
- Watchers: 2
- Forks: 6
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Beautiful Soup Dart
[](https://pub.dev/packages/beautiful_soup_dart)
[](https://codecov.io/gh/mzdm/beautiful_soup)
[comment]: <> ([](https://codecov.io/gh/mzdm/beautiful_soup))
Dart native package inspired by Beautiful Soup 4 Python library. Provides easy ways of navigating, searching, and
modifying the HTML tree.
## Usage
A simple usage example:
```dart
import 'package:beautiful_soup_dart/beautiful_soup.dart';
/// 1. parse a document String
BeautifulSoup bs = BeautifulSoup(html_doc_string);
// use BeautifulSoup.fragment(html_doc_string) if you parse a part of html
/// 2. navigate quickly to any element
bs.body!.a!; // navigate quickly with tags, use outerHtml or toString to get outer html
bs.find('p', class_: 'story'); // finds first element with html tag "p" and which has "class" attribute with value "story"
bs.findAll('a', attrs: {'class': true}); // finds all elements with html tag "a" and which have defined "class" attribute with whatever value
bs.find('', selector: '#link1'); // find with custom CSS selector (other parameters are ignored)
bs.find('*', id: 'link1'); // any element with id "link1"
bs.find('*', regex: r'^b'); // find any element which tag starts with "b", for example: body, b, ...
bs.find('p', string: r'^Article #\d*'); // find "p" element which text starts with "Article #[number]"
bs.find('a', attrs: {'href': 'http://example.com/elsie'}); // finds by "href" attribute
/// 3. perform any other actions for the navigated element
Bs4Element bs4 = bs.body!.p!; // navigate quickly with tags
bs4.name; // get tag name
bs4.string; // get text
bs4.toString(); // get String representation of this element, same as outerHtml
bs4.innerHtml; // get html elements inside the element
bs4.className; // get class attribute value
bs4['class']; // get class attribute value
bs4['class'] = 'board'; // change class attribute value to 'board'
bs4.children; // get all element's children elements
bs4.replaceWith(otherBs4Element); // replace with other element
... and many more
```
Check `test` folder for more examples.
## Table of Contents
The unlinked titles are not yet implemented.
- [Navigating the tree](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#navigating-the-tree)
- [Going down](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#going-down)
- [Navigating using tag names](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#navigating-using-tag-names)
- [.contents and .children](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#contents-and-children)
- [.descendants](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#descendants)
- [.string](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#string)
- [.strings and .strippedStrings](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#strings-and-stripped-strings)
- [Going up](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#going-up)
- [.parent](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#parent)
- [.parents](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#parents)
- [Going sideways](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#going-sideways)
- [.nextSibling and .previousSibling](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#next-sibling-and-previous-sibling)
- [.nextSiblings and .previousSiblings](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#next-siblings-and-previous-siblings)
- [Going back and forth](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#going-back-and-forth)
- [.nextElement and .previousElement]() - returns next/previous Bs4Element
- [.nextElements and .previousElements]()
- [.nextParsed and .previousParsed]() - returns next/previous any parsed Node (doc comments, tags, text), to get its data as String use `node.data`
- [.nextParsedAll and .previousParsedAll]()
- [Searching the tree](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#searching-the-tree)
- [findFirstAny()]() - returns the top most (first) element of the parse tree, of any tag type
- [findAll()](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#find-all)
- [find()](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#find)
- [findParents() and findParent()](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#find-parents-and-find-parent)
- [findNextSiblings() and findNextSibling()](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#find-next-siblings-and-find-next-sibling)
- [findPreviousSiblings() and findPreviousSibling()](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#find-previous-siblings-and-find-previous-sibling)
- [findAllNextElements() and findNextElement()]()
- [findAllPreviousElements() and findPreviousElement()]()
- [findNextParsedAll() and findNextParsed()](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#find-all-next-and-find-next)
- [findPreviousParsedAll() and findPreviousParsed()](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#find-all-previous-and-find-previous)
- [Modifying the tree](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#modifying-the-tree)
- [Changing tag names and attributes](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#changing-tag-names-and-attributes)
- [Modifying .string](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#modifying-string)
- [append()](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#append)
- [extend()](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#extend)
- [newTag()](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#navigablestring-and-new-tag)
- [insert()](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#insert)
- [insertBefore() and insertAfter()](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#insert-before-and-insert-after)
- [clear()](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#clear)
- [extract()](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#extract)
- [decompose()](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#decompose)
- [replaceWith()](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#replace-with)
- [wrap()](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#wrap)
- [unwrap()](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#unwrap)
- smooth()
- [Output](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#output)
- [prettify()](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#pretty-printing) - partial support
- [.text and getText()](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#get-text)
Other methods from the `Element` from [`html package`](https://pub.dev/packages/html) can be accessed via `bs4element.element`.
## Features and bugs
Please file feature requests and bugs at the [issue tracker](https://github.com/mzdm/beautiful_soup/issues) or feel
free to raise a PR.