Skip to main content

Python library to retrieve wiktionary word definitions for different languages

Project description

PyWiktionary

The Python library for wiktionary words

Version 0.1.2

This is an alpha library to retrieve and parse Wiktionary word pages that will require enhancements and fixes

Install

Requirements

If you install this library from source code or you want help with development of the code, make sure to install requirements first:

$ pip install -r ./requirements.txt

Pywiktionary install

Install from the remote pip repository:

$ pip install pywiktionary

Install from the root of the source code:

$ pip install .

How to use

Initialize the parser factory (pywiktionary.wiktionary_parser_factory.WiktionaryParserFactory) with a supported language, then make the request with get_page() method passing the word you desire to get.

from pywiktionary import WiktionaryParserFactory

parser_factory = WiktionaryParserFactory(default_language='en')
pizza_parser = parser_factory.get_page('pizza')

Then to get data about the word use the parse() method of the parser object returned from WiktionaryParserFactory:

parsing_result = pizza_parser.parse()

The result variable is a dictionary containing the result of the wiktionary page parsing divided by type/subtype. Here the result for "pizza":

{
    "meanings": {
        "noun": [
            {
                "meaning": "(uncountable) A baked Italian dish of a thinly rolled bread dough crust typically topped before baking with tomato sauce, cheese, and other ingredients such as meat, vegetables or fruit",
                "examples": [
                    "a slice of pizza",
                    "a pizza pie",
                    "Want to go out for pizza tonight?"
                ]
            },
            {
                "meaning": "(countable) A single instance of this dish",
                "examples": [
                    "He ate a whole pizza!",
                    "Should we cook a frozen pizza for dinner?"
                ]
            }
        ]
    }
}

Summary

This is the summary of above commented code:

from pywiktionary import WiktionaryParserFactory

parser_factory = WiktionaryParserFactory(default_language='en')
pizza_parser = parser_factory.get_page('pizza')
parsing_result = pizza_parser.parse()

Yeah, yeah... i know it is beautiful and easy as idea, but this library require many development to enhance this system!

Supported languages (Language - Code)

  • English - en
  • Italian - it

ToDo

  • Surfable Software Documentation!
  • Implement a good system to select wiktionary language parser
  • Write a good human friend documentation! =)
  • Write some examples for humans!

Main Changes

0.1.2

  • Add requirements in setup.py for distributed package under wheel and PyPI

Project details


Download files

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

Files for pywiktionary, version 0.1a2.post2
Filename, size File type Python version Upload date Hashes
Filename, size pywiktionary-0.1a2.post2-py3-none-any.whl (9.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size pywiktionary-0.1a2.post2.tar.gz (5.6 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page