Library of Congress script transliterator.
Stefano Cossu
ba86a594a7
API documentation; TODO list; raise 400 for internal exceptions.
|
2 سال پیش | |
|---|---|---|
| data | 2 سال پیش | |
| transliterator | 2 سال پیش | |
| .gitignore | 2 سال پیش | |
| Dockerfile | 2 سال پیش | |
| LICENSE | 2 سال پیش | |
| NOTES.md | 2 سال پیش | |
| README.md | 2 سال پیش | |
| TODO.md | 2 سال پیش | |
| entrypoint.sh | 2 سال پیش | |
| requirements.txt | 2 سال پیش | |
| uwsgi.ini | 2 سال پیش | |
| wsgi.py | 2 سال پیش |
README.md
transliterator
REST API service to convert non-Latin scripts to Latin, and vice versa.
Run on Docker
Build container in current dir:
docker build -t transliterator:latest .
Start container:
docker run -e TXL_FLASK_SECRET=changeme -p 8000:8000 transliterator:latest
Web UI
/ renders a simple HTML form to test the transliteration service.
REST API
GET /health
Useful endpoint for health checks.
Response code
200 OK if the service is running.
GET /languages
List all the languages supported.
Response code
200 OK
Response body
MIME type: application/json
Content: a JSON object of the supported language tables. Keys are the keywords
used throughout the API, e.g. for /transliterate. Each key is paired with an
object that contains some basic metadata about the language features. At the
moment, only the human-readable name is available.
GET /table/<lang>
Dump a language table.
URI parameters
<lang>: Language code as given by the/languagesendpoint.
Response code
200 OK
Response body
MIME type: application/json
Content: language configuration as a JSON object with all the transliteration rules as they are read by the application. If the table inherits from a parent, the computed values from the merged tables are shown.
POST /transliterate/<lang>[/r2s]
Transliterate an input string in a given language.
URI parameters
<lang>: Language code as given by the/languagesendpoint.r2s: if appended to the URI, the transliteration is intended to be Roman-to-script, and the input string should be Latin text. If not, the default behavior is followed, which is interpreting the input as a script in the given language, and returning the Romanized text.
POST body
text: Input text to be transliterated.
Response code
200 OKon successful operation.400 Bad Requestfor an invalid request. The reason for the failure is normally printed in the response body.
Response body
MIME Type: text/plain
Content: transliterated string. Characters not found in the mapping are copied verbatim (see "Configuration files" section for more information).
Configuration files
TODO