Docs for Copia

Written on July 6, 2016

I’m creating an open-source app called copia.py for the terminal interface. This tool is designed for creative writing. It creates a tree of words from a root. The list is printed to a file wherever the user is located. The user may cat the file to read the words the tree has found.

Milestones:

Future Features:

The command work like this:

copia test low/medium/high wordnik/wikitionary/etc.

The command copia is the UNIX word to run the Python script copia.py located in the system binary folder.

Test is the root word.

Low/medium/high creates the amount of “branches.” Low creates one request from the database, which is one branch. That branch is a series of synonyms connected to the root word. If no words are found to connect to the root, the procedure stops inquiring the database.

The final argument selects the database to inquiry. For the initial setup, users may choose to install remote or non-remote links to databases. Copia will support a select few at 1.00 release.

Branch 1: looks at all words connected to root and writes it to local file list. Creates a new file titled “Branch 1.” Sends relevant information to “Master Tree.”

Branch 2: looks at generated list and creates another list for each word using each word as a new root (may need to minimize this demand depending on restrictions). Creates a new file titled “Branch 2.” Sends relevant information to “Master Tree.”

Branch 3: looks at branch 2 and runs the same methods. Creates a new file titled “Branch 3.” Sends relevant information to “Master Tree.”

File format:

Branch1.yaml
==========
root: Test
first: Synonym 1
second: Synonym 2
third: Synonym 3
 
Branch2.yaml
==========
root: Synonym 1
first: Synonym 1.1
second: Synonym 1.2
third: Synonym 1.3
 
root: Synonym 2
first: Synonym 2.1

. . .

Take me home.

Check out the archive.