Skip to main content

Script/Library to read and parse sitemap.xml data

Project description

Script and library which reads urls and converts to objects, allows exporting as CSV or JSON.

Handle sitemaps according to: https://www.sitemaps.org/protocol.html

Installation

pip install site-map-parser

Usage

Script usage

smapper $url > /tmp/data.csv

Logs written to ~/sitemap_run.log

Arguments

Argument

Options

Default

Information

-h

N/A

N/A

Outputs argument data

url

e.g. http://www .example.com `` - ``http://www .example.com /other_sitem ap.xml

N/A

Required - sitemap data to retrieve

-l, –log

CRITICAL or ERROR or WARNING or INFO or DEBUG

INFO

logs to sitemapper_ run.log in install folder

-e, –exporter

csv or json

csv

Export format of the data

Library Usage

from sitemapparser import SiteMapParser

sm = SiteMapParser('http://www.example.com')    # reads /sitemap.xml
if sm.has_sitemaps():
    sitemaps = sm.getSitemaps() # returns generator of sitemapper.Sitemap instances
else:
    urls = sm.getUrls()         # returns generator of sitemapper.Url instances

Exporting

Two exporters are available: csv and json

CSV Exporter
from sitemapparser.exporters import CSVExporter

# sm set as per earlier library usage example

csv_exporter = CSVExporter(sm)
if sm.has_sitemaps():
    print(csv_exporter.export_sitemaps())
elif sm.has_urls():
    print(csv_exporter.export_urls())
JSON Exporter
from sitemapparser.exporters import JSONExporter

# sm set as per earlier library usage example

json_exporter = JSONExporter(sm)
if sm.has_sitemaps():
    print(json_exporter.export_sitemaps())
elif sm.has_urls():
    print(json_exporter.export_urls())

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

site-map-parser-0.1.9.tar.gz (6.5 kB view details)

Uploaded Source

Built Distribution

site_map_parser-0.1.9-py3-none-any.whl (9.8 kB view details)

Uploaded Python 3

File details

Details for the file site-map-parser-0.1.9.tar.gz.

File metadata

  • Download URL: site-map-parser-0.1.9.tar.gz
  • Upload date:
  • Size: 6.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.7.5

File hashes

Hashes for site-map-parser-0.1.9.tar.gz
Algorithm Hash digest
SHA256 f058ab9a583795e94de188c32b9085176687098ba59e398e0391cb6219c1aa29
MD5 bad5081194e5c6200c3544ea4d2a3eeb
BLAKE2b-256 8675d0d9ddf0179889bd99b1c435eeec1a0d3f398819d99e0ee6fa6f29b16005

See more details on using hashes here.

File details

Details for the file site_map_parser-0.1.9-py3-none-any.whl.

File metadata

  • Download URL: site_map_parser-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 9.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.7.5

File hashes

Hashes for site_map_parser-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 f4b65208f50cefe51470fc4be4a3f18620a03594e56ff59e6962dddb6ea69466
MD5 577827c951d10a1a78082b14d460352d
BLAKE2b-256 87e054473718742413ce348a3035504b7f479758e6ab2644fc6746d4b68dd657

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page