pykural 1.0.2
Thirukkural for Python. பைதானில் திருக்குறள் !
License: MIT
Keywords: Tamil,Thirukkural,pykural,திருக்குறள்

Pykural
============
<a href="https://ibb.co/Dw7zJnm"><img src="https://i.ibb.co/dkQjTyX/Screenshot-2019-07-14-Snappa-Create-online-graphics-in-a-snap.png" alt="Pykural" border="0"></a>


A python module / command-line tool for pykural | பைதானில் திருக்குறள் !


Install by :
============
```console
$ pip3 install pykural
```

Check out these:
================
```console
$ pykural                    | $ pykural -en  
$ pykural -k 100             | $ pykural -k 100 -en  
$ pykural -a 10              | $ pykural -a 10 -en  
$ pykural -a ilvaazhkkai     | $ pykural -a இல்வாழ்க்கை
$ pykural -a 'domestic life' | $ pykural -i 5  
$ pykural -p 1               | $ pykural --all-paals  
$ pykural --all-iyals        | $ pykural --all-adigaarams
```

```console
$ pykural --github  # opens the github page
$ pykural --pypi    # opens the PyPi page
$ pykural --pepy    # opens the stats page
$ pykural --dev     # opens the developer home page
```

Command Line Usage:
==================
```console
$ pykural -h
usage: pykural [-h] [-en] [-k 1-1330] [-a 1-133] [-i 1-10] [-p 1-3]
                   [--all-paals] [--all-iyals] [--all-adigaarams] [--github]
                   [--pypi] [--pepy] [--dev] [-v] [-s]

pykural by Thiruvalluvar

optional arguments:
  -h, --help        show this help message and exit
  -en               set language as english for -k and -a flag
  -k 1-1330         display the Thirukural and its meaning
  -a 1-133          display the ten Thirukurals in the specified chapter
  -i 1-10           display the Adigaarams in the specified Iyal
  -p 1-3            display the Iyals in the specified Paal
  --all-paals       display all paals (category)
  --all-iyals       display all iyals (sub-category)
  --all-adigaarams  display all adigaarams (chapter)
  --github          opens the github page in the browser
  --pypi            opens the PyPi page in the browser
  --pepy            opens the download stats page in the browser
  --dev             opens the developer homepage
  -v                show version info and exit
  -s                show thiruvalluvar and exit
```

Display a random pykural
-------------------------------------
```
$ pykural

பால்: பொருட்பால்(2/3) | இயல்: ஒழிபியல்(8/10) | அதிகாரம்: பண்புடைமை(100/133)

குறள்-994:
நயனொடு நன்றி புரிந்த பயனுடையார்
பண்புபா ராட்டும் உலகு.

nayanotu nandri purindha payanudaiyaar
paNpupaa raattum ulagu

மு.வ உரை:
நீதியையும் நன்மையையும் விரும்பிப் பிறர்க்குப் பயன்பட வாழும் பெரியோரின்
நல்லப் பண்பை உலகத்தார் போற்றிக் கொண்டாடுவர்.

சாலமன் பாப்பையா உரை:
நீதியையும் அறத்தையும் விரும்பிப் பிறர்க்கும் பயன்படுபவரின் பண்பினை
உலகத்தவர் சிறப்பித்துப் பேசுவர்.

```
```
$ pykural -en

Category: Wealth(2/3) | Sub-Category: Miscellaneous(8/10) | Chapter: Courtesy(100/133)

Verse-994:
Of men of fruitful life, who kindly benefits dispense,
The world unites to praise the 'noble excellence'.

Meaning:
The world applauds the character of those whose usefulness results
from their equity and charity.
```

Show Kural for given kural number
---------------------------------
```
$ pykural -k 335

பால்: அறத்துப்பால்(1/3) | இயல்: துறவறவியல்(3/10) | அதிகாரம்: நிலையாமை(34/133)

குறள்-335:
நாச்செற்று விக்குள்மேல் வாராமுன் நல்வினை
மேற்சென்று செய்யப் படும்.

naachchetru vikkuLmael vaaraamun nalvinai
maeRsendru seyyap padum

மு.வ உரை:
நாவை அடக்கி விக்கல் மேலெழுவதற்கு முன்னே (இறப்பு நெருங்குவதற்கு முன்)
நல்ல அறச்செயலை விரைந்து செய்யத்தக்கதாகும்.

சாலமன் பாப்பையா உரை:
நாவை அடைத்து விக்கல் வருவதற்கு முன், நல்ல செயல்களை விரைந்து செய்ய
வேண்டும்.

```

```
$ pykural -k 335 -en

Category: Righteousness(1/3) | Sub-Category: Ascetic Virtue(3/10) | Chapter: Instability(34/133)

Verse-335:
Before the tongue lie powerless, 'mid the gasp of gurgling breath,
Arouse thyself, and do good deeds beyond the power of death.

Meaning:
Let virtuous deeds be done quickly, before the biccup comes making the
tongue silent.

```

Show Kurals in the given adigaaram
----------------------------------
```
$ pykural -a 40

பால்: பொருட்பால்(2/3) | இயல்: அரசியல்(5/10) | அதிகாரம்: கல்வி(40/133)

குறள்-391:
கற்க கசடறக் கற்பவை கற்றபின்
நிற்க அதற்குத் தக.

குறள்-392:
எண்ணென்ப ஏனை எழுத்தென்ப இவ்விரண்டும்
கண்ணென்ப வாழும் உயிர்க்கு..

குறள்-393:
கண்ணுடையர் என்பவர் கற்றோர் முகத்திரண்டு
புண்ணுடையர் கல்லா தவர்.

குறள்-394:
உவப்பத் தலைக்கூடி உள்ளப் பிரிதல்
அனைத்தே புலவர் தொழில்.

குறள்-395:
உடையார்முன் இல்லார்போல் ஏக்கற்றுங் கற்றார்
கடையரே கல்லா தவர்.

குறள்-396:
தொட்டனைத் தூறும் மணற்கேணி மாந்தர்க்குக்
கற்றனைத் தூறும் அறிவு.

குறள்-397:
யாதானும் நாடாமால் ஊராமால் என்னொருவன்
சாந்துணையுங் கல்லாத வாறு.

குறள்-398:
ஒருமைக்கண் தான்கற்ற கல்வி ஒருவற்கு
எழுமையும் ஏமாப் புடைத்து.

குறள்-399:
தாமின் புறுவது உலகின் புறக்கண்டு
காமுறுவர் கற்றறிந் தார்.

குறள்-400:
கேடில் விழுச்செல்வம் கல்வி யொருவற்கு
மாடல்ல மற்றை யவை.

```

```
$ pykural -a 40 -en

Category: Wealth(2/3) | Sub-Category: Royalty(5/10) | Chapter: Learning(40/133)

Verse-391:
So learn that you may full and faultless learning gain,
Then in obedience meet to lessons learnt remain.

Verse-392:
The twain that lore of numbers and of letters give
Are eyes, the wise declare, to all on earth that live.

Verse-393:
Men who learning gain have eyes, men say;
Blockheads' faces pairs of sores display.

Verse-394:
You meet with joy, with pleasant thought you part;
Such is the learned scholar's wonderous art!.

Verse-395:
With soul submiss they stand, as paupers front a rich man's face;
Yet learned men are first; th'unlearned stand in lowest place.

Verse-396:
In sandy soil, when deep you delve, you reach the springs below;
The more you learn, the freer streams of wisdom flow.

Verse-397:
The learned make each land their own, in every city find a home;
Who, till they die; learn nought, along what weary ways they roam!.

Verse-398:
The man who store of learning gains,
In one, through seven worlds, bliss attains.

Verse-399:
Their joy is joy of all the world, they see; thus more
The learners learn to love their cherished lore.

Verse-400:
Learning is excellence of wealth that none destroy;
To man nought else affords reality of joy.

```
Any of the following commands will also work (for adigaaram alone) (optionally -en flag could be passed)
```
$ pykural -a ilvaazhkkai
$ pykural -a 'domestic life'
$ pykural -a இல்வாழ்க்கை
```


Show Adigaarams in the given Iyal
----------------------------------
```
$ pykural -i 2
----------------------------------------------------------------------------------------------------
No   Chapter                                  Adigaaram                  அதிகாரம்
----------------------------------------------------------------------------------------------------
5    Domestic Life                            Ilvaazhkkai                இல்வாழ்க்கை
6    The Worth of a Wife                      Vaazhkkaith Thunainalam    வாழ்க்கைத் துணைநலம்
7    The Wealth of Children                   Pudhalvaraip Perudhal      மக்கட்பேறு / புதல்வரைப் பெறுதல்
8    The Possession of Love                   Anpudaimai                 அன்புடைமை
9    Hospitality                              Virundhompal               விருந்தோம்பல்
10   The Utterance of Pleasant Words          Iniyavaikooral             இனியவைகூறல்
11   Gratitude                                Seynnandri Aridhal         செய்ந்நன்றி அறிதல்
12   Impartiality                             Natuvu Nilaimai            நடுவு நிலைமை
13   The Possession of Self-restraint         Adakkamudaimai             அடக்கமுடைமை
14   The Possession of Decorum                Ozhukkamudaimai            ஒழுக்கமுடைம
15   Not coveting another's Wife              Piranil Vizhaiyaamai       பிறனில் விழையாமை
16   The Possession of Patience, Forbearance  Poraiyudaimai              பொறையுடைமை
17   Not Envying                              Azhukkaaraamai             அழுக்காறாமை
18   Not Coveting                             Veqkaamai                  வெஃகாமை
19   Not Backbiting                           Purangooraamai             புறங்கூறாமை
20   Against Vain Speaking                    Payanila Sollaamai         பயனில சொல்லாமை
21   Dread of Evil Deeds                      Theevinaiyachcham          தீவினையச்சம்
22   Duty to Society                          Oppuravaridhal             ஒப்புரவறிதல்
23   Giving                                   Eekai                      ஈகை
24   Renown                                   Pukazh                     புகழ்
----------------------------------------------------------------------------------------------------
```

Show Iyals in the given Paal
----------------------------
```
$ pykural -p 1

பால்: அறத்துப்பால்(1/3)
-----------------------------------------------------
No  Sub-Category           Iyal            இயல்
-----------------------------------------------------
1   Prologue               Paayiraviyal    பாயிரவியல்
2   Domestic Virtue        Illaraviyal     இல்லறவியல்
3   Ascetic Virtue         Thuravaraviyal  துறவறவியல்
-----------------------------------------------------
```

Show all Paals
--------------
```
$ pykural --all-paals
---------------------------------------------
No  Category        Paal           பால்
---------------------------------------------
1   Righteousness   Arathuppal     அறத்துப்பால்
2   Wealth          Porutpaal      பொருட்பால்
3   Love            Kaamathuppal   காமத்துப்பால்
---------------------------------------------
```

Show all Iyals
--------------
```
$ pykural --all-iyals
-----------------------------------------------------
No  Sub-Category           Iyal            இயல்
-----------------------------------------------------
1   Prologue               Paayiraviyal    பாயிரவியல்
2   Domestic Virtue        Illaraviyal     இல்லறவியல்
3   Ascetic Virtue         Thuravaraviyal  துறவறவியல்
4   Fate                   Oozhiyal        ஊழியல்
5   Royalty                Arasiyal        அரசியல்
6   Ministers of State     Amaichiyal      அமைச்சியல்
7   Politics               Angaviyal       அங்கவியல்
8   Miscellaneous          Ozhibiyal       ஒழிபியல்
9   The Pre-marital love   Kalaviyal       களவியல்
10  The Post-marital love  Karpiyal        கற்பியல்
-----------------------------------------------------
```

Show all Adigaarams
-------------------
```
$ pykural --all-adigaarams
----------------------------------------------------------------------------------------------------
No   Chapter                                  Adigaaram                  அதிகாரம்
----------------------------------------------------------------------------------------------------
1    The Praise of God                        Katavul Vaazhththu         கடவுள் வாழ்த்து
2    The Blessing of Rain                     Vaansirappu                வான்சிறப்பு
3    The Greatness of Ascetics                Neeththaar Perumai         நீத்தார் பெருமை
4    Assertion of the Strength of Virtue      Aran Valiyuruththal        அறன் வலியுறுத்தல்
5    Domestic Life                            Ilvaazhkkai                இல்வாழ்க்கை
6    The Worth of a Wife                      Vaazhkkaith Thunainalam    வாழ்க்கைத் துணைநலம்
7    The Wealth of Children                   Pudhalvaraip Perudhal      மக்கட்பேறு / புதல்வரைப் பெறுதல்
8    The Possession of Love                   Anpudaimai                 அன்புடைமை
9    Hospitality                              Virundhompal               விருந்தோம்பல்
10   The Utterance of Pleasant Words          Iniyavaikooral             இனியவைகூறல்
...
...
124  Wasting Away                             Uruppunalanazhidhal        உறுப்புநலனழிதல்
125  Soliloquy                                Nenjotukilaththal          நெஞ்சொடுகிளத்தல்
126  Reserve Overcome                         Niraiyazhidhal             நிறையழிதல்
127  Mutual Desire                            Avarvayinvidhumpal         அவர்வயின்விதும்பல்
128  The Reading of the Signs                 Kuripparivuruththal        குறிப்பறிவுறுத்தல்
129  Desire for Reunion                       Punarchchividhumpal        புணர்ச்சிவிதும்பல்
130  Expostulation with Oneself               Nenjotupulaththal          நெஞ்சொடுபுலத்தல்
131  Pouting                                  Pulavi                     புலவி
132  Feigned Anger                            Pulavi Nunukkam            புலவி நுணுக்கம்
133  The Pleasures of Temporary Variance      Oodaluvakai                ஊடலுவகை
----------------------------------------------------------------------------------------------------
```

Show Thiruvalluvar
------------------
```console
$ pykural -s

        yyssssssssssssssssssssyyyyyhhhyyyysooooooooooooooooooooooooooooooooooo
        yssssssssssssssssydmdhhhhhhhdmddhhyyysoooooooooooooooooooooooooooooooo
        sssssssssssssssymNmmddhhhdmhsssssyyyyyysssoooooooooooooooooooooooooooo
        ssssssssssssssyNNNmdhddmmhsooosyhhhhhhhhhdhsoooooooooooooooooooooooooo
        ssssssssssssssmNNmmmmNNNmmmmdhhyyssssyyyyyyyysooooooooooooo+++++oooooo
        sssssssssssooyNNNmNmdNNNNNmdhyyhhhyyyhhhhhyyyyyoooooooooooo++++++ooooo
        sssssssssoooosNNmmmmNNNNNmdddmmmmmddddhsshhhhhysooooooooooo+++++++oooo
        ssssssssssoooohNNNNNNNNNmmNmmhhhdddhhdyyyyysyysoosoooooooooo++++++++oo
        ssssssssoooooooydNNNNNNNNmmddhhddddddddddhhhddddhhsooooooooo++++++++++
        ssssssssooooooooosydNNNNmddmdhyssssssooo+++++oosysoooooooo++++++++++++
        sssssoooooooooooooohNNNNmhhdhsooo+++///:::::----:+oooooo++++++++++++++
        sssoooooooooooooooodNNNNmdmdysso+++////::::-:---:/+oooo+++++++++++++++
        sssoooooooooooooooomNNNmddddhysoo++/////::::::--:/+o+o++++++++++++++++
        sssoooooooooooooooomNNmmmmddhyssoossssyddho:::/shhho++++++++++++++++++
        ssssooooooooooooooodNNmmdmmdhyso+/::+++osyy+/+ys++so++++++++++++++++++
        ssssooooooooooooooodysshmddhyso+/+shhsdmhhys+shyhdhs++++++++++++++++++
        sssssoooooooooooooohyyhydmdyyso+///+sosysooo//s+syyo++++++++++++++++++
        ssssssooooooooooooohyydddmhyyso+/:---:::::+o/-+:::/o++++++++++++++++++
        sssssoooooooooooooohhyhyhdhyyys+/:-------:+o+./:--:+++++++++++++++++++
        sssssoooooooooooooodNhhdhdhyyyso+/::::::/syys+o/:-:+++++++++++++++++++
        sssssoooooooooooooodNNdyhdyyyysso+////++:::ohds/://+++++++++++++++++++
        sssssssoooooooooooyNNNdddmdysyyyssooso/:/shyssyd+/+++++++++++++++++++o
        sssssssoooooooooooyNNmsydmdyssyyyysso+/sdddhhhdmy:/o+++++++++++++++++o
        ysssssssoooooooooymNNhsyddhyssssssoo+ohddhyyssshhs/+oo+++++++++++++ooo
        yssssssssoooooooymmdysshmmdhyssssssyhddhyysssoshddo+so++++++++++++oo++
        ysssssssssooossyhyyssssyddhhyssyyyyhhhhhhhhhyyhhdhs+o/--//+++++++oo+++
        yyyssssssssssoossssssssyddyyysyyyyyyhysydhdhhhyyhyoooo-.-..///++++++++
        yysssoooooooo+++++oossssyhhhysyyyhhysssyysssoooshysss/`...`.:.--/+++++
        yssoo+++++++++++ooosssssshhyyhhyhhhyhhysssooosyhyyyso/.`.-..:/./../+++
        so++//:::::///////++oosssyhddhyyssssyysyyhysyyyssoo++:.``...-/-:+-::-/
        o+//:::::::::::::::::///+oyhdhyysoso++o+oso++/+osoo+:-.``...-.:.o./+..
        +/::::::://////::::::::///+shdddhhysooooso++++ooso/:.-```...-.-.o-+o..
        //::::://////////::::::///+osyhyyyhhhhyhysoooooo+:-...```.`.-.:.o:+-..
        /::::///+++oo+///:::::::://++osyhdddmdmddhyyss+:---...```.`..`:.o/-...
        /:::///++osso+//:::::::::///++oossydddmdhyo+/:.`.-.`..````````-.o-....

```
Rest. . .
============
```console
$ pykural --github  # opens the github page
$ pykural --pypi    # opens the PyPi page
$ pykural --pepy    # opens the stats page
$ pykural --dev     # opens the developer home page
```

Python Usage
============
```python
import pykural
```

Kural class object
------------------
```python
>>> k = pykural.Kural(100)
>>> print(k)                      # <100:இனியவைகூறல்>
>>> print(dir(k))
['__str__', 'adigaaram_en', 'adigaaram_no', 'adigaaram_ta', 'adigaaram_te', 'en_meaning',  
'iyal_en', 'iyal_no', 'iyal_ta', 'iyal_te', 'kural_en', 'kural_ta', 'kural_te', 'no',  
'paal_en', 'paal_no', 'paal_ta', 'paal_te', 'paapaya', 'varadarasan']

```

Adigaaram class object
----------------------
```python
>>> a = pykural.Adigaaram(21)
>>> a1 = pykural.Adigaaram(name='Dread of Evil Deeds')
>>> a2 = pykural.Adigaaram(name='தீவினையச்சம்')
>>> print(a, a1, a2)       		# (<21:தீவினையச்சம்>, <21:தீவினையச்சம்>, <21:தீவினையச்சம்>)
>>> print(a.kurals)
[<201:தீவினையச்சம்>, <202:தீவினையச்சம்>, <203:தீவினையச்சம்>, <204:தீவினையச்சம்>, <205:தீவினையச்சம்>,  
<206:தீவினையச்சம்>, <207:தீவினையச்சம்>, <208:தீவினையச்சம்>, <209:தீவினையச்சம்>, <210:தீவினையச்சம்>]

```

Iyal class object
-----------------
```python
>>> i = pykural.Iyal(5)
>>> print(i)                      # <5:அரசியல்>
>>> print(i.adigaarams)
[<39:இறைமாட்சி>, <40:கல்வி>, <41:கல்லாமை>, <42:கேள்வி>, <43:அறிவுடைமை>, <44:குற்றங்கடிதல்>,  
<45:பெரியாரைத் துணைக்கோடல்>, <46:சிற்றினஞ்சேராமை>, <47:தெரிந்துசெயல்வகை>, <48:வலியறிதல்>,  
<49:காலமறிதல்>, <50:இடனறிதல்>, <51:தெரிந்துதெளிதல்>, <52:தெரிந்துவினையாடல்>, <53:சுற்றந்தழால்>,  
<54:பொச்சாவாமை>, <55:செங்கோன்மை>, <56:கொடுங்கோன்மை>, <57:வெருவந்தசெய்யாமை>, <58:கண்ணோட்டம்>,  
<59:ஒற்றாடல்>, <60:ஊக்கமுடைமை>, <61:மடியின்மை>, <62:ஆள்வினையுடைமை>, <63:இடுக்கணழியாமை>]
```

Paal class object
------------------
```python
>>> p = pykural.Paal(3)
>>> print(p)                     # <3:காமத்துப்பால்>
>>> print(p.iyals)
[<9:களவியல்>, <10:கற்பியல்>]

>>> print(p.adigaarams)
[<109:தகையணங்குறுத்தல்>, <110:குறிப்பறிதல்>, <111:புணர்ச்சிமகிழ்தல்>, <112:நலம்புனைந்துரைத்தல்>, <113:காதற்சிறப்புரைத்தல்>, <114:நாணுத்துறவுரைத்தல்>, <115:அலரறிவுறுத்தல்>, <116:பிரிவாற்றாமை>, <117:படர்மெலிந்திரங்கல்>, <118:கண்விதுப்பழிதல்>, <119:பசப்புறுபருவரல்>, <120:தனிப்படர்மிகுதி>, <121:நினைந்தவர்புலம்பல்>, <122:கனவுநிலையுரைத்தல்>, <123:பொழுதுகண்டிரங்கல்>, <124:உறுப்புநலனழிதல்>, <125:நெஞ்சொடுகிளத்தல்>, <126:நிறையழிதல்>, <127:அவர்வயின்விதும்பல்>, <128:குறிப்பறிவுறுத்தல்>, <129:புணர்ச்சிவிதும்பல்>, <130:நெஞ்சொடுபுலத்தல்>, <131:புலவி>, <132:புலவி நுணுக்கம்>, <133:ஊடலுவகை>]

# returns all the kural objects in the given paal
>>> print(p.kurals) 
```

Show all adigaarams, paals, Iyals
---------------------------------
```python
>>> pykural.Paal.show_all_paals()
>>> pykural.Iyal.show_all_iyals()
>>> pykural.Adigaaram.show_all_adigaarams()
```

Show command line output inside python
--------------------------------------
```python
>>> k = pykural.Kural(10)
>>> k.showCL()

பால்: பொருட்பால்(2/3) | இயல்: ஒழிபியல்(8/10) | அதிகாரம்: பண்புடைமை(100/133)

குறள்-1000:
பண்பிலான் பெற்ற பெருஞ்செல்வம் நன்பால்
கலந்தீமை யால்திரிந் தற்று.

paNpilaan petra perunjelvam nanpaal
kalandheemai yaaldhirinh thatru

மு.வ உரை:
பண்பு இல்லாதவன் பெற்ற பெரிய செல்வம், வைத்த கலத்தின் தீமையால் நல்ல பால்
தன் சுவை முதலியன கெட்டாற் போன்றதாகும்.

சாலமன் பாப்பையா உரை:
நல்ல பண்பு இல்லாதவன் அடைந்த பெரும் செல்வம், பாத்திரக் கேட்டால்
அதிலுள்ள நல்ல பால் கெட்டுப் போவது போலாம்.

>>> k.showCL(lang="en")

Category: Wealth(2/3) | Sub-Category: Miscellaneous(8/10) | Chapter: Courtesy(100/133)

Verse-1000:
Like sweet milk soured because in filthy vessel poured,
Is ample wealth in churlish man's unopened coffers stored.

Meaning:
The great wealth obtained by one who has no goodness will perish like
pure milk spoilt by the impurity of the vessel.

```

The above method showCL() applies to Adigaaram, Paal and Iyal objects as well

# Motivation:
தாம் இன்புறுவது உலகு இன்புறுவது கண்டு  
காமுறுவர் கற்று அறிந்தார்.

யாம் பெற்ற இன்பம் பெறுக இவ்வையகம் - திருமூலர்.

------ நமக்கு ஒரு இன்பம் கிடைத்தால், அது நமக்கு மட்டும் வேண்டும் என்று நினைப்போம்.  ஆனால், பெரியவர்கள் அப்படி நினைக்க மாட்டார்கள். அவர்கள் பெற்ற இன்பத்தை இந்த உலகமும் பெற்று இன்புற வேண்டும் என்று நினைப்பார்கள்.
அதனால் , என்னால் முடிந்ததை நான் செய்கிறேன் . ��