Skip to main content

NewsML converter (AFP news)

Project description

pyconverters_newsml

license tests codecov docs version PyPI - Python Version

Convert AFP NewsML-G2 XML feeds into pymultirole Document objects.

Supports text articles, picture captions, video descriptions, and graphic items. Extracts IPTC media topics, AFP-specific subjects (persons, organisations, locations), keywords, urgency, genre, language, and other metadata.

Installation

pip install pyconverters_newsml

Usage

The converter is registered as a pyconverters.plugins entry point under the name newsml and integrates automatically with the pymultirole plugin system.

Parameters

Parameter Type Default Description
subjects_as_metadata str "" Comma-separated subject types to extract as metadata: medtop, afpperson, afporganization, afplocation, or all.
subjects_code bool False When True, metadata values are "code:name" strings; when False, only the name is stored.
mediatopics_as_categories bool False When True, IPTC media-topic codes are added as hierarchical Category objects.
keywords_as_categories bool False When True, AFP slug keywords are added as Category objects.
natures str "text" Comma-separated list of item natures to include: text, video, picture, graphic.

Developing

Prerequisites

You will need uv and Python 3.12.

Clone the repository:

git clone https://github.com/oterrier/pyconverters_newsml
cd pyconverters_newsml

Install dependencies (including test extras):

uv sync --extra test

Running the test suite

uv run pytest

Linting

uv run ruff check .
uv run ruff format --check .

Building the documentation

uv run --extra docs sphinx-build docs docs/_build

The built documentation is available at docs/_build/index.html.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

pyconverters_newsml-0.6.7.tar.gz (729.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyconverters_newsml-0.6.7-py3-none-any.whl (670.1 kB view details)

Uploaded Python 3

File details

Details for the file pyconverters_newsml-0.6.7.tar.gz.

File metadata

  • Download URL: pyconverters_newsml-0.6.7.tar.gz
  • Upload date:
  • Size: 729.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.2 {"installer":{"name":"uv","version":"0.11.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"12","id":"bookworm","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for pyconverters_newsml-0.6.7.tar.gz
Algorithm Hash digest
SHA256 545447807589de7acb769cda008f6c846e6f4c3b3610a508cd398a30d6e400fe
MD5 4a654500922b07007a6c302b66aa48f2
BLAKE2b-256 2874cea313b62a7f71df3046a89af02626c9847ca02f52a62970747d2bb7d590

See more details on using hashes here.

File details

Details for the file pyconverters_newsml-0.6.7-py3-none-any.whl.

File metadata

  • Download URL: pyconverters_newsml-0.6.7-py3-none-any.whl
  • Upload date:
  • Size: 670.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.2 {"installer":{"name":"uv","version":"0.11.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"12","id":"bookworm","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for pyconverters_newsml-0.6.7-py3-none-any.whl
Algorithm Hash digest
SHA256 d4078f1fb6613e83028decf8e51019afe5dfebe0b4a7cef1799a1a327f7e5cc1
MD5 e8ab722f100141c2422be777ae78849d
BLAKE2b-256 83c9df5386ac598dda9256229e89174f3d81023049175dd6ac25d1aa0e6d7615

See more details on using hashes here.

Supported by

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