wiktionary-api 0.1.0__tar.gz

wiktionary_api-0.1.0/.gitignore

@@ -0,0 +1,176 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# PyPI configuration file
+.pypirc
+
+# test files
+
+test.pdf
+*.wav

wiktionary_api-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Nebil Ibrahim
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

wiktionary_api-0.1.0/PKG-INFO

@@ -0,0 +1,109 @@
+Metadata-Version: 2.5
+Name: wiktionary-api
+Version: 0.1.0
+Summary: Synchronous Python client for the Wikimedia Wiktionary REST API
+Project-URL: Homepage, https://github.com/NebilI/WiktionaryPythonAPI
+Project-URL: Repository, https://github.com/NebilI/WiktionaryPythonAPI
+Project-URL: Issues, https://github.com/NebilI/WiktionaryPythonAPI/issues
+Project-URL: Documentation, https://github.com/NebilI/WiktionaryPythonAPI#readme
+Author: Nebil Ibrahim
+License-Expression: MIT
+License-File: LICENSE
+Keywords: dictionary,requests,rest-api,wikimedia,wiktionary
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Text Processing :: Linguistic
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: pypdf2<4,>=3.0.1
+Requires-Dist: requests<3,>=2.32
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == 'dev'
+Requires-Dist: pytest>=8.3; extra == 'dev'
+Requires-Dist: ruff>=0.9; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# WiktionaryPythonAPI
+
+Synchronous Python client for the [Wiktionary REST API](https://en.wiktionary.org/api/rest_v1/#/) and related [Commons Core](https://api.wikimedia.org/wiki/Core_REST_API) 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](docs/ENDPOINTS.md) for the full path → method map.
+
+## Install
+
+Works with any PEP 517 installer:
+
+```bash
+pip install wiktionary-api
+```
+
+```bash
+uv add wiktionary-api
+```
+
+```bash
+poetry add wiktionary-api
+```
+
+Requires **Python 3.10+**.
+
+## Quick start
+
+Wikimedia requires a descriptive [User-Agent](https://foundation.wikimedia.org/wiki/Policy:Wikimedia_Foundation_User-Agent_Policy) with your application name and a contact email or URL.
+
+```python
+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)
+
+| Area | Examples |
+|------|----------|
+| Page content | `page`, `get_definition`, `get_html`, `get_lint`, `get_mobile_html`, `get_revision`, `get_media_file_list`, `get_pdf` |
+| Data / mobile | `get_citation`, `get_mobile_css`, `get_mobile_javascript`, `get_i18n` |
+| Reading lists | `get_lists`, `create_list`, `update_list`, `delete_list`, entry CRUD, setup/teardown |
+| Transforms | `transform_wikitext_to_html`, `transform_html_to_wikitext`, `transform_wikitext_to_lint`, `transform_wikitext_to_mobile_html` |
+| Math | `check_math`, `get_math_formula`, `render_math` |
+| Commons helpers | `get_media_files`, `download_media_files` |
+
+Method docstrings document parameters, return types, and REST paths. Official sandbox: https://en.wiktionary.org/api/rest_v1/#/
+
+## Development
+
+```bash
+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](.github/PYPI_PUBLISHING.md).
+
+## License
+
+MIT — see [LICENSE](LICENSE).

wiktionary_api-0.1.0/README.md

@@ -0,0 +1,77 @@
+# WiktionaryPythonAPI
+
+Synchronous Python client for the [Wiktionary REST API](https://en.wiktionary.org/api/rest_v1/#/) and related [Commons Core](https://api.wikimedia.org/wiki/Core_REST_API) 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](docs/ENDPOINTS.md) for the full path → method map.
+
+## Install
+
+Works with any PEP 517 installer:
+
+```bash
+pip install wiktionary-api
+```
+
+```bash
+uv add wiktionary-api
+```
+
+```bash
+poetry add wiktionary-api
+```
+
+Requires **Python 3.10+**.
+
+## Quick start
+
+Wikimedia requires a descriptive [User-Agent](https://foundation.wikimedia.org/wiki/Policy:Wikimedia_Foundation_User-Agent_Policy) with your application name and a contact email or URL.
+
+```python
+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)
+
+| Area | Examples |
+|------|----------|
+| Page content | `page`, `get_definition`, `get_html`, `get_lint`, `get_mobile_html`, `get_revision`, `get_media_file_list`, `get_pdf` |
+| Data / mobile | `get_citation`, `get_mobile_css`, `get_mobile_javascript`, `get_i18n` |
+| Reading lists | `get_lists`, `create_list`, `update_list`, `delete_list`, entry CRUD, setup/teardown |
+| Transforms | `transform_wikitext_to_html`, `transform_html_to_wikitext`, `transform_wikitext_to_lint`, `transform_wikitext_to_mobile_html` |
+| Math | `check_math`, `get_math_formula`, `render_math` |
+| Commons helpers | `get_media_files`, `download_media_files` |
+
+Method docstrings document parameters, return types, and REST paths. Official sandbox: https://en.wiktionary.org/api/rest_v1/#/
+
+## Development
+
+```bash
+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](.github/PYPI_PUBLISHING.md).
+
+## License
+
+MIT — see [LICENSE](LICENSE).

wiktionary_api-0.1.0/docs/ENDPOINTS.md

@@ -0,0 +1,119 @@
+# Endpoint coverage
+
+This package wraps the **English Wiktionary** Wikimedia REST API (`rest_v1`) plus Commons Core API helpers for downloading media bytes.
+
+Coverage was verified against the live OpenAPI spec at `https://en.wiktionary.org/api/rest_v1/?spec` (41 path patterns). The `Wiktionary` class exposes a method for every documented route.
+
+## Official documentation
+
+| Resource | URL |
+|----------|-----|
+| Interactive API docs (Swagger UI) | https://en.wiktionary.org/api/rest_v1/#/ |
+| OpenAPI spec (JSON) | https://en.wiktionary.org/api/rest_v1/?spec |
+| Wikimedia REST API overview | https://www.mediawiki.org/wiki/Wikimedia_REST_API |
+| Commons Core API (media file downloads) | https://api.wikimedia.org/wiki/Core_REST_API |
+
+## Summary
+
+| Category | Status |
+|----------|--------|
+| All paths in the Wiktionary OpenAPI spec | Implemented |
+| PDF rendering (`GET /page/pdf/…`) | Implemented (`get_pdf`); works on Wiktionary but omitted from `?spec` |
+| Wikipedia-only routes (e.g. `/page/summary/`) | Out of scope |
+| MediaWiki Action API (`/w/api.php`) | Out of scope |
+
+## Page content
+
+| HTTP | REST path | Client method |
+|------|-----------|---------------|
+| GET | `/page/` | `page()` |
+| GET | `/page/definition/{term}` | `get_definition` |
+| GET | `/page/html/{title}` | `get_html` |
+| GET | `/page/html/{title}/{revision}` | `get_html` |
+| GET | `/page/lint/{title}` | `get_lint` |
+| GET | `/page/lint/{title}/{revision}` | `get_lint` |
+| GET | `/page/media-list/{title}` | `get_media_file_list` |
+| GET | `/page/media-list/{title}/{revision}` | `get_media_file_list` |
+| GET | `/page/mobile-html/{title}` | `get_mobile_html` |
+| GET | `/page/mobile-html/{title}/{revision}` | `get_mobile_html` |
+| GET | `/page/mobile-html-offline-resources/{title}` | `get_mobile_html_offline_resources` |
+| GET | `/page/mobile-html-offline-resources/{title}/{revision}` | `get_mobile_html_offline_resources` |
+| GET | `/page/title/{title}` | `get_revision` |
+| GET | `/page/title/{title}/{revision}` | `get_revision` |
+| GET | `/page/pdf/{title}/{format}/{type}` | `get_pdf`, `download_pdf` *(not in OpenAPI spec)* |
+
+## Data
+
+| HTTP | REST path | Client method |
+|------|-----------|---------------|
+| GET | `/data/citation/{format}/{query}` | `get_citation` |
+| GET | `/data/css/mobile/{type}` | `get_mobile_css` |
+| GET | `/data/javascript/mobile/{type}` | `get_mobile_javascript` |
+| GET | `/data/i18n/{type}` | `get_i18n` |
+| GET | `/data/lists/` | `get_lists` |
+| POST | `/data/lists/` | `create_list` |
+| POST | `/data/lists/batch` | `create_lists_batch` |
+| GET | `/data/lists/changes/since/{date}` | `get_list_changes_since` |
+| GET | `/data/lists/pages/{project}/{title}` | `get_lists_for_page` |
+| POST | `/data/lists/setup` | `setup_lists` |
+| POST | `/data/lists/teardown` | `teardown_lists` |
+| PUT | `/data/lists/{id}` | `update_list` |
+| DELETE | `/data/lists/{id}` | `delete_list` |
+| GET | `/data/lists/{id}/entries/` | `get_list_entries` |
+| POST | `/data/lists/{id}/entries/` | `create_list_entry` |
+| POST | `/data/lists/{id}/entries/batch` | `create_list_entries_batch` |
+| DELETE | `/data/lists/{id}/entries/{entry_id}` | `delete_list_entry` |
+
+Reading list endpoints require an authenticated session and a `csrf_token` query parameter.
+
+## Transform
+
+| HTTP | REST path | Client method |
+|------|-----------|---------------|
+| POST | `/transform/wikitext/to/html` | `transform_wikitext_to_html` |
+| POST | `/transform/wikitext/to/html/{title}` | `transform_wikitext_to_html` |
+| POST | `/transform/wikitext/to/html/{title}/{revision}` | `transform_wikitext_to_html` |
+| POST | `/transform/html/to/wikitext` | `transform_html_to_wikitext` |
+| POST | `/transform/html/to/wikitext/{title}` | `transform_html_to_wikitext` |
+| POST | `/transform/html/to/wikitext/{title}/{revision}` | `transform_html_to_wikitext` |
+| POST | `/transform/wikitext/to/lint` | `transform_wikitext_to_lint` |
+| POST | `/transform/wikitext/to/lint/{title}` | `transform_wikitext_to_lint` |
+| POST | `/transform/wikitext/to/lint/{title}/{revision}` | `transform_wikitext_to_lint` |
+| POST | `/transform/wikitext/to/mobile-html/{title}` | `transform_wikitext_to_mobile_html` |
+
+Pass `title=None` (and optionally `revision=None`) to hit the path variants without `{title}` in the URL.
+
+## Media / math
+
+| HTTP | REST path | Client method |
+|------|-----------|---------------|
+| POST | `/media/math/check/{type}` | `check_math` |
+| GET | `/media/math/formula/{hash}` | `get_math_formula` |
+| GET | `/media/math/render/{format}/{hash}` | `render_math` |
+
+`check_math` accepts `tex`, `inline-tex`, or `chem`. `render_math` accepts `svg`, `mml`, or `png`.
+
+## Commons helpers (not Wiktionary REST v1)
+
+| Purpose | Client method |
+|---------|---------------|
+| Download media bytes for a page | `get_media_files` |
+| Save media files to disk | `download_media_files` |
+
+## Utilities
+
+| Purpose | Symbol |
+|---------|--------|
+| Save PDF response bytes | `pdf_from_bytes` (`wikt.util`) |
+
+## Out of scope
+
+- `/page/summary/{title}`, talk pages, recommendations (Wikipedia-only)
+- MediaWiki Action API (`https://en.wiktionary.org/w/api.php`)
+- Offline dumps → [wiktextract](https://github.com/tatuylonen/wiktextract)
+
+## Re-checking coverage
+
+```bash
+python -c "import requests; s=requests.get('https://en.wiktionary.org/api/rest_v1/?spec', headers={'User-Agent':'MyApp (you@example.com)'}).json(); print(len(s['paths']), 'paths')"
+```

wiktionary_api-0.1.0/pyproject.toml

@@ -0,0 +1,89 @@
+[build-system]
+requires = ["hatchling>=1.24"]
+build-backend = "hatchling.build"
+
+[project]
+name = "wiktionary-api"
+version = "0.1.0"
+description = "Synchronous Python client for the Wikimedia Wiktionary REST API"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+authors = [
+    { name = "Nebil Ibrahim" },
+]
+keywords = ["wiktionary", "wikimedia", "dictionary", "rest-api", "requests"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Text Processing :: Linguistic",
+    "Typing :: Typed",
+]
+dependencies = [
+    "requests>=2.32,<3",
+    "PyPDF2>=3.0.1,<4",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.3",
+    "ruff>=0.9",
+    "build>=1.2",
+]
+
+[project.urls]
+Homepage = "https://github.com/NebilI/WiktionaryPythonAPI"
+Repository = "https://github.com/NebilI/WiktionaryPythonAPI"
+Issues = "https://github.com/NebilI/WiktionaryPythonAPI/issues"
+Documentation = "https://github.com/NebilI/WiktionaryPythonAPI#readme"
+
+[dependency-groups]
+dev = [
+    "pytest>=8.3",
+    "ruff>=0.9",
+    "build>=1.2",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/wikt"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/src",
+    "/tests",
+    "/docs",
+    "/README.md",
+    "/LICENSE",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+src = ["src", "tests"]
+
+[tool.ruff.lint]
+select = [
+    "E",   # pycodestyle errors
+    "W",   # pycodestyle warnings
+    "F",   # pyflakes
+    "I",   # isort
+    "B",   # flake8-bugbear
+    "UP",  # pyupgrade
+]
+ignore = [
+    "E501",  # line length handled separately; docs/URLs are long
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**/*.py" = ["B011"]

wiktionary_api-0.1.0/src/wikt/__init__.py

@@ -0,0 +1,11 @@
+"""Python client for the Wikimedia Wiktionary REST API."""
+
+from .client import Wiktionary
+from .util import pdf_from_bytes
+
+__all__ = [
+    "Wiktionary",
+    "pdf_from_bytes",
+]
+
+__version__ = "0.1.0"