From 2361547527f29a7797317884b362320f079606b1 Mon Sep 17 00:00:00 2001 From: drdhaval2785 Date: Sat, 13 Jan 2018 19:41:35 +0530 Subject: [PATCH] v0.0.5 started --- HISTORY.rst | 5 +++++ docs/usage.rst | 32 ++++++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+) diff --git a/HISTORY.rst b/HISTORY.rst index 63a63c8..3dee137 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -25,3 +25,8 @@ jsonindex.json file which was crucial and missed in v0.0.2, added back. 2. Adding data file in system specific locations like APPDATA. See #6 . 3. Made code python 2.7, 3.3, 3.4, 3.5, 3.6 compliant. 4. Corrected all errors / smells identified by landscape.io. + +0.0.5 (2018-01-13) +------------------ + +1. Added verb form generation facility. See https://github.com/drdhaval2785/prakriya/issues/39. diff --git a/docs/usage.rst b/docs/usage.rst index 5bdad18..b8e5aef 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -2,6 +2,9 @@ Usage ===== +prakriya +-------- + To use prakriya in a project:: >>> from prakriya import Prakriya @@ -77,6 +80,27 @@ Valid values of ``field`` and expected output are as follows. ``vachana`` - Returns the vacana of the given verb form. +Generate verb forms +------------------- + +To get verb form for given verb, tense, suffix / (purusha and vachana) in a project:: + + >>> from prakriya import Generate + >>> g = Generate() + +There are two ways to get verb forms for given verb. + + >>> g[verb, tense, purusha, vachana] + + >>> g[verb, tense, suffix] + +Examples are as follows + + >>> g['BU', 'law', 'praTama', 'eka'] + + >>> g['BU', 'law', 'tip'] + + Transliteration --------------- @@ -95,3 +119,11 @@ If you want to set the input or output transliteration, follow these steps. Valid transliterations are slp1, itrans, hk, iast, devanagari, wx, bengali, gujarati, gurmukhi, kannada, malayalam, oriya and telugu. They can be used both as input transliteration and output transliteration schemes. + +For using transliterations in Generate class, use as below. + +>>> from prakriya import Generate +>>> g = Generate() +>>> g.inputTranslit('hk') # Customize 'hk' +>>> g.outputTranslit('devanagari') # Customize 'devanagari' +>>> g['bhU', 'laT', 'jhi'] # Takes the input in hk Transliteration