rex/nimpath
1
0
Fork 0
mirror of https://github.com/weskerfoot/NimPath synced 2026-01-14 21:31:33 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
55 commits 1 branch 2 tags 73 KiB
Find a file
Exact
Wesley Kerfoot fdbe12cc86 cleanup
2023-07-12 00:50:46 -04:00
src cleanup 2023-07-12 00:50:46 -04:00
tests move test html files 2023-07-11 17:28:09 -04:00
config.nims pass include flags with pkg-config 2023-07-11 18:00:27 -04:00
license.txt add license 2023-07-05 13:40:12 -04:00
nimpath.nimble version bump 0.1.10 2023-07-11 01:53:37 -04:00
README.md update readme with list of build deps 2023-07-11 17:57:44 -04:00

README.md

API to allow for parsing HTML/XML and querying it using XPath expressions

https://nimble.directory/pkg/nimpath

Important: requires you to have libxml2 installed

build dependencies:

  • clang
  • pkg-config
  • libxml2 (installed system-wide)

Example

var parsed = parseHTML("<html><body><h1>foobar</h1></body></html>", "")

var nodes : seq[HTMLNode] = toSeq(xpathQuery(parsed, "//*"))

assert map(nodes, (n) => n.node_name.get) == @["html", "body", "h1"]

for node in xpathQuery(parsed, "//*"):
    if node.node_name.isSome and node.node_name.get == "h1":
        assert node.textContent.get == "foobar"

Example using queryWithContext to query against subnodes.


var parsed = parseHTML("<html><body><h3>foobar</h3><h3>sdasdasd</h3><div><span>this is a span</span><span>this is another span</span></div><h1 id='some_id' class='header1'>foo bar baz</h1></body></html>")

for node in xpathQuery(parsed, "//div"):
    for subnode in queryWithContext(node, ".//*"):
        assert $subnode.node.name == "span"

See the tests for more detailed examples. You can run the tests with nimble test.

I have also written up a quick guide here with a more detailed explanation of how the library works.

To install, add nimpath to your .nimble file, and make sure clang is installed. If you installed libxml2 using something other than your package manager, it may require setting the linker flags in config.nims manually and/or using LD_LIBRARY_PATH.

You must also add this code to config.nims to get it to build.

import strutils
switch("passL", staticExec("pkg-config --libs libxml-2.0").strip)