Skip to content

eric-s-s/sentences

Repository files navigation

sentences v3.3

This module creates randomly generated paragraphs and then assigns specific kinds of errors to those paragraphs. It outputs this text to a pdf file. To install and run:

$ git clone https://github.com/eric-s-s/sentences.git
$ cd sentences
$ python setup.py install  # or pip install .
$ gen_pdf

To create an msi or dmg file:

$ python setup_cx_freeze.py bdist_msi  # or bdist_mac

note: There is an issue with creating a shortcut. See details here.

note: The .msi file does not seem to do updates. Each separate version of the program must be uninstalled before the new one can be installed.

GUI options details:

  • Main Options
    • Save current settings: Saves the current setting to the config file. They will be set at startup.
    • Export settings: Saves the current settings to a .cfg file that can be loaded later.
    • Reset to saved settings: Reloads the config file.
    • Load config file: Loads setting from a .cfg file.
    • New default word files: Moves "nouns.csv", "verbs.csv" and "uncountable.csv" to new locations (such as "nouns_old_01.csv") and then copies the default word files.
    • Factory Reset: Overwrites the config file and default word files without saving them.
    • Add a file prefix: When the file is created, this prefix is added to the filename.
    • Font size: The font size of the error file from 2-20.
    • Make me some PDFs: Creates an error file and an answer file in your save_folder.
  • File Management Options: Set where to save files, and where the word lists are located.
    • Customizing your word lists: You can customize your word lists. Use the defaults as templates, or simply edit the default. Then use "New default word files" to move your changed files and make new defaults.
    • Each "SET" button allows you to choose the location of the file.
  • Error Options: Choose the frequency of errors and what kinds of errors occur.
    • % chance for error: The chance that any one word or punctuation will get a grammatical error.
    • noun errors: Errors such as: "a water", "the rices", "cat" (no article or plural ending), "a cats"
    • pronoun errors: Mixes up object and subject pronouns.
    • verb errors: Mixes up third-person and non-third-person endings. Swaps tenses.
    • is do errors: Changes "subj VERB" to "subj. BE-VERB infinitive" (He plays. -> He is play.)
    • transpose preposition errors: Puts the prepositional phrase between subject and verb ("He with a cat plays.")
    • period errors: Changes period and capital letter to comma and lower-case letter (without a conjunction)
  • Paragraph Type Options: Choose size of paragraph, how many paragraph and how subjects are selected.
    • choose a paragraph type: Determines the algorithm for selecting subjects.
      • pool: Creates a pool of subjects of size: "subject pool size". Each sentence randomly selects a subject from the pool.
      • chain: Each object becomes the subject of the subsequent sentence.
    • number of paragraphs: How many paragraphs are in the PDFs.
    • sentences per paragraph: How many sentences in each paragraph.
    • subject pool size: The size of the subject pool. If "chain" is selected, this is ignored.
  • Paragraph Grammar Options:
    • choose a tense: Determines if your paragraphs are in simple present tense or simple past tense.
    • % chance of plural noun: The probability that any countable noun will be assigned as plural.
    • % chance of negative verb: The probability that any verb will be assigned as negative (go -> don't go).
    • % chance of pronoun: The probability that any subject or object will be a randomly selected pronoun.