Metadata-Version: 2.1
Name: wiktionaryparser
Version: 0.0.95
Summary: A tool to parse word data from wiktionary.com into a JSON object
Home-page: https://github.com/Suyash458/WiktionaryParser
Author: Suyash Behera
Author-email: sne9x@outlook.com
License: UNKNOWN
Download-URL: https://github.com/Suyash458/WiktionaryParser/archive/master.zip
Description: ### Wiktionary Parser
        
        A python project which parses word content from Wiktionary in an easy to use JSON format.
        Right now, it parses etymologies, definitions, pronunciations, examples, audio links and related words.
        
        ![Downloads](http://pepy.tech/badge/wiktionaryparser)
        
        #### JSON structure
        
        ```json
        [{
            "pronunciations": {
                "text": ["pronunciation text"],
                "audio": ["pronunciation audio"]
            },
            "definitions": [{
                "relatedWords": [{
                    "relationshipType": "word relationship type",
                    "words": ["list of related words"]
                }],
                "text": ["list of definitions"],
                "partOfSpeech": "part of speech",
                "examples": ["list of examples"]
            }],
            "etymology": "etymology text",
        }]
        ```
        
        #### Installation
        
        ##### Using pip 
        * run `pip install wiktionaryparser`
        
        ##### From Source
        * Clone the repo or download the zip
        * `cd` to the folder
        * run `pip install -r "requirements.txt"`
        
        #### Usage
        
         - Import the WiktionaryParser class.
         - Initialize an object and use the `fetch("word", "language")` method.
         - The default language is English, it can be changed using the `set_default_language method`.
         - Include/exclude parts of speech to be parsed using `include_part_of_speech(part_of_speech)` and `exclude_part_of_speech(part_of_speech)`
         - Include/exclude relations to be parsed using `include_relation(relation)` and `exclude_relation(relation)`
        
        #### Examples
        
        ```python
        >>> from wiktionaryparser import WiktionaryParser
        >>> parser = WiktionaryParser()
        >>> word = parser.fetch('test')
        >>> another_word = parser.fetch('test', 'french')
        >>> parser.set_default_language('french')
        >>> parser.exclude_part_of_speech('noun')
        >>> parser.include_relation('alternative forms')
        ```
        
        #### Requirements
        
         - requests==2.7.0
         - beautifulsoup4==4.4.0
        
        #### Contributions
        
        If you want to add features/improvement or report issues, feel free to send a pull request!
        
Keywords: Parser,Wiktionary
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Description-Content-Type: text/markdown
