mkv-this/README.md

disclaimer

i wrote this cli rapper for the markovify python module because i wanted its features to be available as a cli tool.

i only published it to share with friends.

& in case a programmer felt like picking it up and improving on it. so if you are interested in fixing amateur code, then by all means!

maybe this functionality already exists somewhere, but i couldn't find it. if it does, pls let me know!

mkv-this

mkv-this is a script that outputs a bunch of bot-like sentences based on a bank of text that you feed it, either from a local text file or a URL, and saves the results to a text file. if you run it again with the same output file, the new results are appended after the old ones.

a second command, mkv-this-dir (see below) allows you to input a directory and it will read all text files within it as the input.

mkv-this simply makes some of the features of the excellent markovify module available as a command line tool. it was written by a total novice, so you probably shouldn’t download it. i only learned about argparser yesterday, and pypi.org today, no matter what day it is. tomorrow i might learn about os and sys. and then maybe even cookiecutter!

installing

install it with pip, the python package manager:

python3 -m pip install mkv-this

or

pip install mkv-this

to do this you need python3 and pip. install them through your system's package manager. on debian (+ derivatives), for example, you'd run:

sudo apt install python3 python3-pip

markovify is a dependency, but should install along with mkv-this.

if you get sth like ModuleNotFound error: No module named '$modulename', just run pip install $modulename to get the missing module.

options

the script implements a number of the basic markovify options, so you can specify:

• how many sentences to output (default = 5).
• the state size, i.e. the number of preceding words to be used in calculating the choice of the next word (default = 2).
• a maximum sentence length, in characters.
• the amount of (verbatim) overlap allowed between input and output.
• if your text's sentences end with newlines rather than full-stops.
• an additional file or URL to use for text input. you can add only one. if you want to feed a stack of files into your bank, use mkv-this-dir.
• the relative weight to give to the second file if it is used.

run mkv-this -h to see how to use these options.

mkv-this-dir: markovify a directory of text files

if you want to input a stack of files, use mkv-this-dir instead. specify a directory and all text files in it will be used as input.

as with mkv-this you can also combine this directory with a URL.

if for some reason you want to get a similar funtionality with mkv-this, you can easily concatenate the files yourself from the command line, then process the resulting file:

• copy all your text files into a directory
• cd into the directory
• run cat * > outputfile.txt
• run mkv-this on your newly created file: mkv-this outputfile.txt
• if mkv-this-dir returns lots of chars that don't display because they it can't read the encoding, try this out instead.

file types

you need to input plain text files. currently accepted file extensions are .txt, .org and .md. it is trivial to add others, so if you want one included just ask.

for best results

feed mkv-this large-ish amounts of well punctuated text. it works best if you bulk replace/remove as much mess as possible (URLs, code, HTML tags, metadata, stars, bullets, lines, etc.), unless you want mashed versions of those things in your output. (no need to clean up URLs though.)

you’ll probably want to edit or select things from the output. it is very much supposed to be a kind of raw material rather than print-ready boilerplate bosh, although many bots are happily publishing such output directly. you might find that it prompts you to edit it like a bot yourself.

for a few further tips, see https://github.com/jsvine/markovify#basic-usage.

happy zaning.

macos

it seems to run on macos too.

you may already have python installed. if not, you first need to install homebrew, edit your PATH so that it works, then install python3 with brew install python3. if you are already running an old version of homebrew you might need to run brew install python3 && brew postinstall python3 to get python3 and pip running right.

i know nothing about macs so if you ask me for help i'll just send you random copypasta from the interwebs.

todo

• option to also append input model to a saved JSON file. (i.e. text_model.to_json(), markovify.Text.from_json())
• learn how to programme.