Initial code

Author: neta-elad

.gitignore

@@ -0,0 +1,6 @@
+.env
+.mypy_cache
+.pyconlang
+.pytest_cache
+build
+*.egg-info

Makefile

@@ -0,0 +1,43 @@
+.PHONY: all
+all: format lint type test
+
+.PHONY: lint
+lint: 
+	isort . -q
+	autoflake . --recursive \
+				--exclude .env \
+				--remove-unused-variables \
+				--remove-all-unused-imports \
+				--expand-star-imports \
+				--in-place
+
+.PHONY: format
+format:
+	black .
+
+.PHONY: type
+type:
+	mypy --strict pyconlang
+
+
+.PHONY: test
+test:
+	pytest -q
+
+
+.PHONY: env
+env:
+	! [ -d .env ] && python3 -m venv .env || true
+
+.PHONY: install
+install:
+	yes | pip uninstall pyconlang
+	pip install -e .[test]
+
+diagrams.html: pyconlang/lexicon/parser.py
+	python -m pyconlang.lexicon.parser
+
+.PHONY: clean
+clean:
+	rm -r .env
+	rm diagrams.html

README.md

@@ -0,0 +1,205 @@
+# Pyconlang
+A collection of Python utilities for conlanging.
+
+### Installing
+Requires `python >= 3.10`:
+```shell
+$ pip install git+https://github.com/neta-elad/pyconlang.git
+```
+
+No need to install Lexurgy separately, 
+since it is bundled with Pyconlang.
+However, you do need Java 8 or higher installed
+(per Lexurgy's requirements).
+
+## How to Use
+Initialize a new project:
+```shell
+$ pyconlang init -n Simatsan -a Biblaridion simatsan
+$ cd simatsan
+```
+
+Run an interactive 
+[Lexurgy](https://github.com/def-gthill/lexurgy) 
+session:
+```shell
+$ pyconlang repl
+```
+
+Compile the reference grammar and lexicon:
+```shell
+$ pyconlang book compile
+```
+or continuously watch for changes and re-compile:
+```shell
+$ pyconlang book watch
+```
+
+For more information and help:
+```shell
+$ pyconlang --help
+```
+
+## Book Format
+Pyconlang uses 
+[Markdown](https://daringfireball.net/projects/markdown/),
+Lexurgy,
+and its own lexicon file-format 
+to generate a reference grammar and lexicon
+for your conlang.
+The book's style is heavily inspired by
+David J. Peterson's template.
+
+Under the hood, Pyconlang uses
+[Python-Markdown](https://python-markdown.github.io/)
+with several extensions to support
+[including files](https://github.com/neurobin/mdx_include)
+and [extended markup](https://python-markdown.github.io/extensions/).
+
+Sound changes are defined in `changes.lsc`, 
+and applied using Lexurgy.
+
+Pyconlang's lexicon is defined in `lexicon.txt`.
+You define basic entries using the `entry` declaration:
+```
+entry <stone> *apak (n.) stone, pebble 
+```
+
+For some entries,
+you may want to define
+its form in some mid-point
+in the conlang's evolution.
+This is done using the `@rule` syntax:
+```
+entry <hard> *apaki@after-palatalization (adj.) hard, strong, stable 
+```
+
+When applying sound changes to this entry,
+only rules after (and including) `after-palatalization`
+will apply.
+You may find it useful to create explicit no-op rules
+in `changes.lsc`:
+```
+after-palatalization:
+    unchanged
+```
+
+Note that spaces are allowed
+when defining entries,
+so you need not restrict yourself to single words:
+```
+entry <to eat 27 strawberries> *mata (v.) to eat 27 strawberries, to be gluttonous
+```
+
+You can also define affixes, 
+to be used when inserting entries:
+```
+affix .PL *ikim
+affix COL. *ma
+
+entry <gravel> <stone>.PL (n.) gravel, a pile of stones
+entry <monument> COL.<stone> (n.) monument, memorial site
+```
+Affixes can also be defined in some mid-point
+(using the `@rule` syntax)
+or by using compounds (`COL.<pile>`).
+
+Additionally,
+you can define lexical sources of affixes,
+and a short description:
+```
+affix .PL *ikim (<big> <pile>) plural suffix for all nouns
+```
+When there is exactly one lexical source,
+you may omit the affix's form:
+```
+affix .PL (<pile>)
+```
+
+Sometimes, a group of entries should be displayed
+with a list of forms. 
+For example, all nouns show their collective and plural form.
+This is accomplished by templates:
+```
+template &noun $ $.PL COL.$
+
+entry &noun <apple> *saka (n.) apple, any kind of tree-fruit
+```
+
+You can see the diagrams for the lexicon syntax
+[here](https://htmlpreview.github.io/?https://github.com/neta-elad/pyconlang/blob/main/diagrams.html).
+
+### Complete Example
+Given the sound changes `changes.lsc`:
+```
+Class vowel {a, e, i, o, u}
+
+palatalization:
+    k => ʃ / _ i
+
+after-palatalization:
+    unchanged
+
+intervocalic-voicing:
+    {p, t, k, s} => {b, d, g, z} / @vowel _ @vowel
+
+romanizer:
+    ʃ => sh
+```
+
+and the lexicon `lexicon.txt`:
+```
+template &noun $ $.PL COL.$
+    
+affix .PL *ikim@after-palatalization (<big> <pile>) plural suffix for all nouns
+affix COL. (<pile>)
+
+entry <big> *iki (adj.) big, great
+entry <pile> *ma (n.) pile, heap
+
+entry &noun <stone> *apak (n.) stone, pebble
+entry <gravel> <stone>.PL (n.) gravel, a pile of stones
+entry <monument> COL.<stone> (n.) monument, memorial site
+```
+
+The following entries will appear in the book:
+> ...
+> ## A
+> **abagigim** _\*apak_ + _\*ikim_ (n.) gravel, a pile of stones
+> 
+> **abak**, **abagigim**, **maabak** _\*apak_ (n.) stone, pebble
+> 
+> ...
+> ## I
+> **ishi** _\*iki_ (adj.) big, great
+> 
+> ...
+> ## M
+> **ma** _\*ma_ (n.) pile, heap
+>
+> **maabak** _\*ma_ + _\*apak_ (n.) monument, memorial site
+>
+> ...
+
+
+
+## TODO
+- [ ] `repl`: Interactive session with Lexurgy
+  - [x] Enter proto form, get romanized modern form
+  - [ ] Get phonetic modern form
+  - [ ] Get simplified (no accents) romanized modern form
+- [ ] `lexurgy`: Evolving forms and auto-glomination
+  - [x] Evolve and auto-glominate forms at the correct point of time
+  - [ ] Handle stress
+- [ ] `lexicon`: Interactive lexicon
+  - [ ] Define word by canonical
+  - [ ] Find by canonical, proto, affix, or definition
+- [ ] `translator`: Automatic translation according to gloss
+  - [ ] Evolve each form (with affixes)
+  - [ ] Match-up forms and glosses
+- [ ] `book`: Generate a grammar/lexicon reference with less boilerplate
+  - [x] Conlang-to-English lexicon, with entries, affixes and templates:
+  - [ ] Affixes list
+  - [ ] Phonology tables
+  - [ ] Conjugation tables
+  - [ ] Inline translation