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.4.1

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. The meanings type categories are dynamically taken from the Wiktionary page in the wiktionary language, 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.

Source Distribution

pywiktionary-0.4a1.post1.tar.gz (6.1 kB view details)

Uploaded Source

Built Distribution

pywiktionary-0.4a1.post1-py3-none-any.whl (9.6 kB view details)

Uploaded Python 3

File details

Details for the file pywiktionary-0.4a1.post1.tar.gz.

File metadata

  • Download URL: pywiktionary-0.4a1.post1.tar.gz
  • Upload date:
  • Size: 6.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.0

File hashes

Hashes for pywiktionary-0.4a1.post1.tar.gz
Algorithm Hash digest
SHA256 53c4a5c903e5bca8c97bf3339d8f4a2accbf6601fdf99a2c1fd254aaf1c4bce4
MD5 cab0f24e091f84c6936c8c4a5a2253d0
BLAKE2b-256 d1fecfebb5b1795b64083cdc55b59fc5762568d2cdc48d6f3df6e86e0d604d22

See more details on using hashes here.

File details

Details for the file pywiktionary-0.4a1.post1-py3-none-any.whl.

File metadata

  • Download URL: pywiktionary-0.4a1.post1-py3-none-any.whl
  • Upload date:
  • Size: 9.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.0

File hashes

Hashes for pywiktionary-0.4a1.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 a821fed1f00599c996e500563c543fe7158ebad3ce0eb1105ca7818c3dbafa60
MD5 c9962a55de9d9d8f815ba1baa8bdc21a
BLAKE2b-256 fa81b662ad47fb23ad3770807e94187dcd370beef61f04c43dd6349346bff7b5

See more details on using hashes here.

Supported by

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