meta_oxide 0.1.1

Universal metadata extraction library supporting 13 formats (HTML Meta, Open Graph, Twitter Cards, JSON-LD, Microdata, Microformats, RDFa, Dublin Core, Web App Manifest, oEmbed, rel-links, Images, SEO) with 7 language bindings
Documentation 
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355

"""
Tests for JSON-LD WebSite type (Schema.org WebSite)

Following TDD approach - tests written FIRST before implementation
"""

import meta_oxide
import pytest


class TestWebSiteBasic:
    """Test basic WebSite extraction"""

    def test_website_basic(self):
        """Test minimal website with name"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "WebSite",
                "name": "Example Tech Blog"
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "WebSite"
        assert objects[0]["name"] == "Example Tech Blog"


class TestWebSiteWithSearchAction:
    """Test WebSite with potentialAction for site search"""

    def test_website_with_search_action(self):
        """Test website with SearchAction for site search"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "WebSite",
                "name": "Example Site",
                "url": "https://example.com",
                "potentialAction": {
                    "@type": "SearchAction",
                    "target": "https://example.com/search?q={search_term_string}",
                    "query-input": "required name=search_term_string"
                }
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "WebSite"
        assert objects[0]["name"] == "Example Site"
        assert objects[0]["url"] == "https://example.com"
        assert "potentialAction" in objects[0]


class TestWebSiteWithPublisher:
    """Test WebSite with publisher organization"""

    def test_website_with_publisher(self):
        """Test website with publisher organization"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "WebSite",
                "name": "Tech News",
                "url": "https://technews.example.com",
                "publisher": {
                    "@type": "Organization",
                    "name": "Tech Media Corp",
                    "logo": {
                        "@type": "ImageObject",
                        "url": "https://example.com/logo.png"
                    }
                }
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "WebSite"
        assert objects[0]["name"] == "Tech News"
        assert "publisher" in objects[0]


class TestWebSiteWithLanguage:
    """Test WebSite with inLanguage"""

    def test_website_with_language(self):
        """Test website with inLanguage field"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "WebSite",
                "name": "French Blog",
                "url": "https://fr.example.com",
                "inLanguage": "fr-FR"
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "WebSite"
        assert objects[0]["name"] == "French Blog"
        assert objects[0]["inLanguage"] == "fr-FR"


class TestWebSiteWithCopyright:
    """Test WebSite with copyright information"""

    def test_website_with_copyright(self):
        """Test website with copyright holder and year"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "WebSite",
                "name": "Corporate Site",
                "url": "https://corporate.example.com",
                "copyrightHolder": {
                    "@type": "Organization",
                    "name": "Example Corp"
                },
                "copyrightYear": "2024"
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "WebSite"
        assert objects[0]["name"] == "Corporate Site"
        assert "copyrightHolder" in objects[0]
        assert objects[0]["copyrightYear"] == "2024"


class TestWebSiteComplete:
    """Test complete WebSite with all fields"""

    def test_website_complete(self):
        """Test website with all supported fields"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "WebSite",
                "name": "Complete Example Site",
                "description": "A comprehensive website with all metadata",
                "url": "https://complete.example.com",
                "image": "https://example.com/logo.png",
                "inLanguage": "en-US",
                "copyrightYear": "2024",
                "copyrightHolder": {
                    "@type": "Organization",
                    "name": "Complete Inc"
                },
                "publisher": {
                    "@type": "Organization",
                    "name": "Complete Publishing"
                },
                "potentialAction": {
                    "@type": "SearchAction",
                    "target": "https://complete.example.com/search?q={search_term_string}",
                    "query-input": "required name=search_term_string"
                }
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        website = objects[0]
        assert website["@type"] == "WebSite"
        assert website["name"] == "Complete Example Site"
        assert website["description"] == "A comprehensive website with all metadata"
        assert website["url"] == "https://complete.example.com"
        assert website["image"] == "https://example.com/logo.png"
        assert website["inLanguage"] == "en-US"
        assert website["copyrightYear"] == "2024"
        assert "copyrightHolder" in website
        assert "publisher" in website
        assert "potentialAction" in website


class TestWebSiteRealistic:
    """Test realistic WebSite examples"""

    def test_blog_website(self):
        """Test realistic blog website"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "WebSite",
                "name": "Personal Tech Blog",
                "description": "Articles about software development, AI, and technology",
                "url": "https://myblog.dev",
                "inLanguage": "en-US",
                "potentialAction": {
                    "@type": "SearchAction",
                    "target": "https://myblog.dev/search?q={search_term_string}",
                    "query-input": "required name=search_term_string"
                },
                "publisher": {
                    "@type": "Person",
                    "name": "Jane Developer",
                    "url": "https://myblog.dev/about"
                }
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        website = objects[0]
        assert website["@type"] == "WebSite"
        assert website["name"] == "Personal Tech Blog"
        assert "description" in website
        assert "potentialAction" in website
        assert "publisher" in website

    def test_ecommerce_website(self):
        """Test e-commerce site with search"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "WebSite",
                "name": "Example Store",
                "description": "Online shopping for electronics and gadgets",
                "url": "https://store.example.com",
                "image": {
                    "@type": "ImageObject",
                    "url": "https://store.example.com/logo.png",
                    "width": 600,
                    "height": 60
                },
                "potentialAction": {
                    "@type": "SearchAction",
                    "target": {
                        "@type": "EntryPoint",
                        "urlTemplate": "https://store.example.com/search?q={search_term_string}"
                    },
                    "query-input": "required name=search_term_string"
                },
                "publisher": {
                    "@type": "Organization",
                    "name": "Example Store Inc",
                    "logo": "https://store.example.com/publisher-logo.png"
                }
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        website = objects[0]
        assert website["@type"] == "WebSite"
        assert website["name"] == "Example Store"
        assert website["description"] == "Online shopping for electronics and gadgets"
        assert website["url"] == "https://store.example.com"
        assert "image" in website
        assert "potentialAction" in website
        assert "publisher" in website


class TestWebSiteIntegration:
    """Test WebSite integration with extract_all()"""

    def test_extract_all_includes_website(self):
        """Test that extract_all() includes WebSite"""
        html = """
        <html>
        <head>
            <title>My Website</title>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "WebSite",
                "name": "Sample Website",
                "url": "https://sample.example.com"
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        data = meta_oxide.extract_all(html)

        assert "jsonld" in data
        assert len(data["jsonld"]) == 1
        assert data["jsonld"][0]["@type"] == "WebSite"
        assert data["jsonld"][0]["name"] == "Sample Website"
        assert data["jsonld"][0]["url"] == "https://sample.example.com"


if __name__ == "__main__":
    pytest.main([__file__, "-v"])