Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sloev/gutenhaiku
Guten Haiku extracts Haiku poems from text
https://github.com/sloev/gutenhaiku
Last synced: 11 minutes ago
JSON representation
Guten Haiku extracts Haiku poems from text
- Host: GitHub
- URL: https://github.com/sloev/gutenhaiku
- Owner: sloev
- License: mit
- Created: 2020-03-14T23:29:22.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-01-16T10:46:27.000Z (almost 4 years ago)
- Last Synced: 2024-11-01T19:52:35.583Z (7 days ago)
- Language: Python
- Size: 766 KB
- Stars: 48
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - sloev/gutenhaiku - Guten Haiku extracts Haiku poems from text (others)
README
# Guten Haiku
[](https://travis-ci.org/sloev/gutenhaiku) [](https://pypi.python.org/pypi/gutenhaiku) [](https://pypi.python.org/pypi/gutenhaiku)
A Commandline tool to mine haiku poems from text
* 80's cli interface with **colors**
* Works great with gutenberg books thx to a builtin cleaner script from [Peyman Mohseni Kiasari](https://github.com/kiasar/gutenberg_cleaner)
* Reconstructs punctuation of haikus using [deepcorrect](https://github.com/bedapudi6788/deepcorrect)
* Appends json haiku's to a file
## Install
```bash
$ pip install gutenhaiku
```
Then you need to download the models in cache:
```bash
$ gutenhaiku setup
```
## Usage
```bash
$ gutenhaiku -f frankenstein.txt -a 'mary shelley' -t 'frankenstein' -d '1818-01-01'
```
```bash
Wat? Guten Haiku lets you extract haiku poems from text
Usage: gutenhaiku \
-f frankenstein.txt \
-a 'Mary Wollstonecraft Shelley' \
-t 'frankenstein' \
-d '1818-01-01'
Optional params: --commandfile [-cf] a file with comma seperated
values for f,a,t,d params
--outputfile [-o] the output file path [default haiku.json
--eighties [-e] eighties mode [default 1]
Advanced usage: gutenhaiku \
-f frankenstein.txt \
-a 'Mary Wollstonecraft Shelley' \
-t 'frankenstein' \
-d '1818-01-01' \
-f dracula.txt \
-a 'Bram Stoker' \
-t 'dracula' \
-d '1897-05-26'
setup: gutenhaiku setup
downloads AI models
```
### Output format
*example from [assets](assets/frankenstein_haiku.json)*
```json
{
"page": 261,
"word_number": 65407,
"haiku": [
"He pointed towards.",
"The corpse of my wife I rushed.",
"Towards the window."
],
"author": "mary shelley",
"title": "frankenstein",
"date": "1818-01-01T00:00:00"
}
```
## Dev
Run tests with
```bash
$ poetry run nox
```