Metadata-Version: 2.1
Name: pywiktionary
Version: 0.3a0.post1
Summary: Python library to retrieve wiktionary word definitions for different languages
Home-page: UNKNOWN
Author: Alessandro Mesti
Author-email: mesti.alessandro@gmail.com
License: UNKNOWN
Project-URL: Code, https://github.com/alessandrome/pywiktionary
Description: # PyWiktionary
        
        The Python library for wiktionary words
        
        ## Version 0.2.0
        
        This is an alpha library to retrieve and parse [Wiktionary](https://wiktionary.org) 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.
        ```python
        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:
        ```python
        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:
        ```python
        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
Keywords: w,i,k,t,i,o,n,a,r,y, ,p,a,r,s,e,r, ,s,c,r,a,p,e,r, ,w,o,r,d, ,w,o,r,d,s, ,m,u,l,t,i,l,i,n,g,u,a,l
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Text Processing
Classifier: Topic :: Text Processing :: Linguistic
Classifier: Topic :: Text Processing :: Markup :: HTML
Description-Content-Type: text/markdown
