README.md
1<!--
2 Copyright 2015, NICTA
3
4 This software may be distributed and modified according to the terms of
5 the BSD 2-Clause license. Note that NO WARRANTY is provided.
6 See "LICENSE_BSD2.txt" for details.
7
8 @TAG(NICTA_BSD)
9-->
10
11# Python Isabelle Symbols Module
12
13This directory contains Python functionality for translation between Isabelle's
14ascii representations (e.g. `\<forall>`) and its unicode representations (e.g.
15`���`). You need to provide it with a copy of Isabelle's internal "symbols" file
16that it uses to form translation mappings.
17
18Example usage:
19
20```python
21import isasymbols
22
23t = isasymbols.make_translator('/path/to/symbols')
24print t.encode('\\<lbrakk>A; B\\<rbrakk> \\<Longrightarrow> A')
25```
26
27For anything more complicated, please consult the source.
28