python-bidi 0.3.1

python-bidi is a bi-directional layout implementation in pure Python.<br /><br />API<br /><br />The algorithm starts with a single entry point bidi.algorithm.get_display.<br /><br />Required arguments:<br /><br /> * unicode_or_str: The orginal unicode or string (i.e: storage). If it's a string use the optional argument encoding to specify it's encoding.<br /><br />Optional arguments:<br /><br /> * encoding: If unicode_or_str is a string, specifies the encdoing. The algorithm uses unicodedata which requires unicode. This encoding will be used to decode and encode back to string before returning (default: "utf-8").<br /> * upper_is_rtl: True to treat upper case chars as strong 'R' for debugging (default: False).<br /> * debug: True to display (using sys.stderr) the steps taken with the algorithm (default: False).<br /><br />Returns the display layout, either as unicode or encoding encoded string (depending on the type of unicode_or_str').<br /><br />Example:<br /><br />>>> from bidi.algorithm import get_display<br />>>> get_display(u'car is THE CAR in arabic', upper_is_rtl=True)<br />u'car is RAC EHT in arabic'<br /><br />CLI<br /><br />pybidi is a command line utility (calling bidi.main) for running the bidi algorithm. the script can get a string as a parameter or read text from stdin. Usage:<br /><br />$ pybidi -h<br />Usage: pybidi [options]<br /><br />Options:<br /> -h, --help show this help message and exit<br /> -e ENCODING, --encoding=ENCODING<br /> Text encoding (default: utf-8)<br /> -u, --upper-is-rtl treat upper case chars as strong 'R' for debugging<br /> (default: False).<br /> -d, --debug Display the steps taken with the algorithm<br /><br />Examples:<br /><br /> $ pybidi -u 'car is THE CAR in arabic'<br /> car is RAC EHT in arabic<br /><br /> $ cat ~/Documents/example.txt | pybidi<br /> ...<br /><br />Running tests<br />--------------<br /><br />To run the tests:<br /><br />python -m bidi.tests<br /><br /><br />#md5=662d16b18f03c7a6eae7a4884bdf8f2f

Requirements:	No special requirements
Platforms:	*nix, Linux
Keyword:	039r039,  Algorithm,  Arabic,  Bidi,  Chars,  Debug,  Debugging,  Default,  Display,  Encoding,  False,  Layout,  Pybidi,  Python,  Python Bidi,  Steps,  String,  Strong,  Treat,  Unicode,  Unicode Str,  Upper
Users rating:	0/10