Skip to main content

cli wrapper for markovify: take a text file, markovify, output the results to a text file.

Project description

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 little script that outputs a bunch of bot-like sentences based on a bank of text that you feed it. the results are saved 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 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.

as of 0.1.29 you can also specify:

  • a URL to a text file online. (you can input something that isn't a text file but the results will be mush or the programme will crash.)
  • an additional URL to use as text input.

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

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

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

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

  • 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.

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())
  • maybe some copy in some basic webscraping boilerplate code.
  • learn how to programme.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkv-this-0.1.32.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

mkv_this-0.1.32-py3-none-any.whl (25.3 kB view details)

Uploaded Python 3

File details

Details for the file mkv-this-0.1.32.tar.gz.

File metadata

  • Download URL: mkv-this-0.1.32.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.3

File hashes

Hashes for mkv-this-0.1.32.tar.gz
Algorithm Hash digest
SHA256 3fffe94feb1a40152a3cd81103666ac7bf848cf8648fb33a8874518e297d2b77
MD5 fbaa588bf17f9cb44c4a0e4a149333ea
BLAKE2b-256 551c9ee5c0889885945f2efb9abc0f04c6ece08c3272e0a11c07a08d0b5e9e94

See more details on using hashes here.

File details

Details for the file mkv_this-0.1.32-py3-none-any.whl.

File metadata

  • Download URL: mkv_this-0.1.32-py3-none-any.whl
  • Upload date:
  • Size: 25.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.3

File hashes

Hashes for mkv_this-0.1.32-py3-none-any.whl
Algorithm Hash digest
SHA256 e7aaa1e9e08c0c516b7f586eed976a066edc4021558bca7a811f3535405719b1
MD5 66fdf5b7ca1ad224e1ce1a49db36933a
BLAKE2b-256 e57a7ee1d5b4093acc8d198bcc7b5613626076d35527b642ca1b16d69d4692c9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page