Metadata-Version: 2.1
Name: kwiki
Version: 0.0.6
Summary: A parser of the Kurdish wiktionary (Wikiferheng)
Home-page: https://github.com/kurd-cc/kwiki
Author: Jagar Yousef
Author-email: <jagar.yousef@gmail.com>
License: UNKNOWN
Keywords: kurdish,language,language-processing,kurmanji,wiktionary,parser
Platform: UNKNOWN
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Description-Content-Type: text/markdown


# KWIKI



A parser for the Kurdish Wiktionary with >5.9K Kurdish (Kurmanji) words.

<br>

It is helpful to get the following of Kurdish Wiktionary words:

- Position of the Kurdish word

- Glosses of the Kurdish word

- Synonyms of the Kurdish word

- Tags of the Kurdish word

- Form of, of the Kurdish word

- Sounds of the Kurdish word

<br>





### Installation:



```shell

pip install kwiki

```



<br>



### Usage:



1. Import the package:



```python

from kwiki import kwiki

```



2. Available methods:

    1) ### `getAllWordsData`: <br>

        will return the whole set of words' objects.

    2) ### `find`: <br>

       will find an array of the matched words from the set.

       <br>

       ```python

        kwiki.find('dem')

        ```

       ```python

        [{

                        "name": "cog",

                        "args": {

                            "1": "sa",

                            "2": "दीति",

                            "3": "",

                            "4": "brightness; time",

                            "tr": "dītí"

                        },

                        "expansion": "Sanskrit दीति (dītí, “brightness; time”)"

                    }

                ],

                "word": "dem",

                "lang": "Northern Kurdish",

                "lang_code": "kmr",

                "senses": [

                    {

                        "tags": [

                            "feminine"

                        ],

                        "glosses": [

                            "time"

                        ],

                        "id": "dem-noun",

                        "categories": []

                    }

                ]

            }]

       ```

    3) ### `find_one`: <br>

       will find only one object of the matched word

       <br>

       ```python

        kwiki.find_one('dem')

        ```

       ```python

        {

                        "name": "cog",

                        "args": {

                            "1": "sa",

                            "2": "दीति",

                            "3": "",

                            "4": "brightness; time",

                            "tr": "dītí"

                        },

                        "expansion": "Sanskrit दीति (dītí, “brightness; time”)"

                    }

                ],

                "word": "dem",

                "lang": "Northern Kurdish",

                "lang_code": "kmr",

                "senses": [

                    {

                        "tags": [

                            "feminine"

                        ],

                        "glosses": [

                            "time"

                        ],

                        "id": "dem-noun",

                        "categories": []

                    }

                ]

            }

       ```

   4) ### `get_synonyms`: <br>

      will return the synonyms of the word if existed

      <br>

      ```python

       kwiki.get_synonyms('tav')

       ```

      ```python

        { 

            'synonyms': [{ 'word': 'roj' }]

        }

      ```

   5) ### `get_glosses`: <br>

       will return the glosses of the word if existed

       <br>

      ```python

       kwiki.get_glosses('tav')

       ```

      ```javascript

        { 

            'glosses':  [ 'sun, sunlight' ] 

        }

      ```

   6) ### `get_tags`: <br>

      will return the tags of the word if existed

      <br>

      ```python

       kwiki.get_tags('tav')

       ```

      ```python

        { 

            'tags':  [ 'feminine' ] 

        }

      ```

   7) ### `get_form_of`: <br>

       will return the "form of" of the word if existed

       <br>

      ```kwiki

       kwiki.get_form_of('aland')

       ```

      ```python

        { 

            form_of:  [ { word: 'alandin' } ]

        }

      ```

   8) ### `get_pos`: <br>

      will return the position of the word

      <br>

      ```python

       kwiki.get_pos('aland')

       ```

      ```kwiki

        { 

            'pos':  'verb'

        }

      ```

   9) ### `get_sounds`: <br>

       will return the sounds of the word if existed

       <br>

       ```python

       kwiki.get_sounds('roj')

       ```

      ```python

        { 

            'sounds':   [ { 'ipa': '/roːʒ/' }, { 'rhymes': '-oːʒ' } ]

        }

      ```

      

<br>





      

