0.1

Simple version

Author: zvezdochiot

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2015 unabashed
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,33 @@
+# Yoficator
+
+> A Russian text yoficator (ёфикатор).
+
+## What does it do?
+It conservatively replaces every `е` to `ё` when it's unambiguously a case of the latter. No context is used; it relies entirely on a lack of dictionary entries for a correspondent "truly `е`" homograph. 
+
+Yoficating Russian texts removes some unnecessary ambiguities.
+
+To learn more, check Wikipedia in [English](https://en.wikipedia.org/wiki/Yoficator) or [Russian](https://ru.wikipedia.org/wiki/Ёфикатор).
+
+## Usage
+Depends on yoficator.dic, which is used for the lookup and should remain in the same folder.
+
+`yoficator.py [text-file-in-Russian | string-in-Russian]`
+
+## Examples
+Running the command without arguments parses the test file:
+
+`yoficator.py`
+
+Or just use it with a file or string:
+```bash
+yoficator.py russianfile.txt    # prints to STDOUT
+yoficator.py russianfile.txt > russianfile-yoficated.txt
+yoficator.py "Где ее книга?"
+```
+
+## Limitations
+* The code being conservative and not looking for context, it won't correct when a "truly `е`" homograph exists. Thus a "`все`" will never be corrected, because both `все` and `всё` exist as different words.
+* Prone to wrongly yoficate other Cyrillic-based languages, such as Bulgarian, Ukrainian, Belarussian.
+* It's not the fastest thing in the world, mind you. But does the job.
+

tests/yoficator.txt

@@ -0,0 +1,4 @@
+(Tests the parsing)
+Ambiguous, stays е:    все
+Unambiguous, changes:  щетка, произнес, еще, ее
+