skip to navigation
skip to content

rasmipy 0.2

Reduce Arabic strings to their rasm, ie remove vocalization and other diacritics.

Reduce Arabic strings to their rasm, i.e. remove vocalization and other diacritics.

Usage

>>> from rasmipy import rasmify
>>> rasmify('الفَاتِحَة')
'الڡاٮحه'

Installation

From the Python Package Index:

$ pip install ramsipy

From the sources:

$ python setup.py install

With the optional REST interface:

$ pip install ramsipy[rest-api]

REST API

To run a REST service:

$ rasmify-rest-service

Or in a Docker container (with the HTTP port mapped to 8000):

$ docker run –rm -p 8000:80 telota/rasmify

Example GET request:

$ curl http://localhost:8000/?text=ءَاتَيۡنَا

Example POST request:

$ curl -H “Content-Type: text/plain” -d ‘ءَاتَيۡنَا’ -X POST http://localhost:8000/

There are two environment variables that can be used to configure the service:

PORT defines the port that the server listens, defaults to 8000. MAX_GET_PARAMETER_LENGTH defines the allowed maximum length of GET requests, defaults to 1024.

Resources

Contributing

In order to run the tests, you need to install pytest and related packages, preferably in a virtual environment:

$ pip install -r requirements-dev.txt

Install rasmipy in an editable mode:

$ python setup.py develop

Before committing changes, you should run the tests:

# in the project's root directory
$ pytest
 
File Type Py Version Uploaded on Size
rasmipy-0.2.tar.gz (md5) Source 2017-05-05 3KB