mousebot
/
mkv-this
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

readme after removing _dir

This commit is contained in:
mousebot 2020-04-26 18:06:15 -03:00
parent fd7da0418d
commit ad7d3d1949
2 changed files with 9 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -1,14 +1,12 @@
## disclaimer
`mkv-this` makes some of the features of the excellent [markovify](https://github.com/jsvine/markovify) module available as a command line tool. i started on it because i wanted to process my own offline files the same way [fedibooks](https://fedibooks.com) can process mastodon toots. then i published it to share with friends. i'm a totally novice coder, so you are a programmer and felt like picking it up and improving on it, then by all means!
`mkv-this` makes some of the features of the excellent [markovify](https://github.com/jsvine/markovify) module available as a command line tool. i started on it because i wanted to process my own offline files the same way [fedibooks](https://fedibooks.com) processes mastodon toots. then i published it to share with friends. i'm a novice coder, so you are a programmer and felt like picking it up and improving on it, then by all means!
the rest of these notes are for end users rather than programmers.
## 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` 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, a URL or a directory, and saves the results to another text file. if you run it again with the same output file, new results are appended after old ones.
both commands allow you to add a second file or URL to the input, so you can combine your secret diary with some vile shit from the webz.
@ -39,24 +37,21 @@ the script implements a number of the basic `markovify` options, so you can spec
* 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. handy for inputting poetry.
* 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` (see below).
* the relative weight to give to the second file if it is used.
* an additional file or URL to use for text input. if you want to feed a stack of files into your bank, use `mkv-this-dir` (see below).
* the relative weight to give to the second file/URL if used.
run `mkv-this -h` to see how to use these options.
### mkv-this-dir: markovify a directory of text files
### directories
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.
`mkv-this` accepts a directory as input. it will read all text files in it and use them as a single input.
as with `mkv-this` you can also combine your 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:
if for some reason you want to concatenate your files yourself, you can easily do so 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.
* run mkv-this on the file: `mkv-this outputfile.txt`
### file types

2
setup.py
View File

@ -9,7 +9,7 @@ with open(path.join(this_directory, "README.md"), encoding="utf-8") as f:
setup(
name="mkv-this",
version="0.1.44",
version="0.2.0",
description="cli wrapper for markovify: take a text file or URL, markovify, save the results.",
long_description=long_description,
long_description_content_type="text/markdown",