No clear usage instruction

[nbmustafa]

Hi Kaka @sinaahmadi, very well done for the great effort you have been doing to fill this gap. once tiny feedback, I have noticed your instructions to run this tool is not up to date in README file. e.g pip3 needs to be used instead of pip since you are already using pythong3.*.

Also the instruction of the usage is not quite clear, would have been great if you put some complete examples?

nashwan@Nashwan:~/Desktop/klpt/klpt$ import klpt dialect sorani
-bash: import: command not found

[sinaahmadi]

Hi @nashvan,

Thanks for your comment and happy that the toolkit is of interest to you 🙂

The documentation is written with the assumption that the user/developer has sufficient knowledge about Python. pip3 is used only when there is more than one version of Python installed and therefore, managing packages is carried out differently. Likewise for running examples; they should be run in a .py file as Python3 example.py or directly in the Python environment of the Terminal/command line. To move from the bash environment to Python, simply type Python.

I hope this helps :-)

[nbmustafa]

@sinaahmadi thank for the reply, do you mind to share one example of the command that can run the tool? I am struggling to make it run, I am sure I must be missing an argument or such for the command I am using, I tried multiple options:

python setup.py import klpt dialect sorani script "Arabic" numeral ١٢٣٤٥٦٧٨٩٠

[sinaahmadi]

There are two ways to run Python:

1. When opening your Terminal/command line, type python and enter. This will change the environment from bash to Python. Then, write your Python code. This is handy for quick tasks where reusing the code is not a priority.
2. Create a file with the .py extension. Then, write your Python code inside. Then, from your command line/Terminal, run the file as python my_file.py.

Find more at https://realpython.com/run-python-scripts/

[nbmustafa]

@sinaahmadi thanks for your reply, but thats really not what i am after I know very well how to run python scripts. My question is very specific to your tool and what are the arguments need to passed to when running your tool. But all good dont worry will try to reverse engineer your tool and figure out whats needs to be passed to.

[sinaahmadi]

I guess you should note that KLPT is a toolkit, not a script. So, I'm afraid there is no argument to be passed to run it through the command line!