WiktionaryPythonAPI

Synchronous Python client for the Wiktionary REST API and related Commons Core media downloads.

PyPI: wiktionary-api · Import: wikt

Covers all 41 path patterns in the live OpenAPI spec (?spec), plus PDF rendering and Commons helpers. See docs/ENDPOINTS.md for the full path → method map.

Install

Works with any PEP 517 installer:

pip install wiktionary-api

uv add wiktionary-api

poetry add wiktionary-api

Requires Python 3.10+.

Quick start

Wikimedia requires a descriptive User-Agent with your application name and a contact email or URL.

from wikt import Wiktionary

wiki = Wiktionary("MyApp", "you@example.com")

# Definitions (Wiktionary-specific)
print(wiki.get_definition("hello"))

# HTML / revision metadata
print(wiki.get_html("hello")[:200])
print(wiki.get_revision("hello"))

# Math (check → render)
checked = wiki.check_math("tex", "E=mc^2")
svg = wiki.render_math("svg", checked["resource_location"])

API surface (summary)

Method docstrings document parameters, return types, and REST paths. Official sandbox: https://en.wiktionary.org/api/rest_v1/#/

Development

pip install -e ".[dev]"
# or: uv sync --all-extras
ruff check src tests
ruff format src tests
pytest tests/ -v

Publishing

Releases publish to PyPI on v* tags via trusted publishing. See .github/PYPI_PUBLISHING.md.

License

MIT — see LICENSE.