Update Exploring Near Earth Objects project and add Meme Generator project
This commit is contained in:
39
Meme_Generator/README.md
Normal file
39
Meme_Generator/README.md
Normal file
@@ -0,0 +1,39 @@
|
||||
## Meme Generator Project
|
||||
|
||||
### Overview
|
||||
The goal of this project is to build a "meme generator" – a multimedia application to dynamically generate memes, including an image with an overlaid quote.
|
||||
|
||||
|
||||
### Set up environment
|
||||
```sh
|
||||
$ sudo apt-get install -y xpdf
|
||||
$ pip install -r requirements.txt
|
||||
```
|
||||
|
||||
### Run program
|
||||
|
||||
Python test \
|
||||
Usage: `python3 meme.py --path [image_path] --body [quote_body] --author [quote_author]`
|
||||
```sh
|
||||
$ mkdir tmp
|
||||
$ python3 meme.py
|
||||
```
|
||||
|
||||
Flask test
|
||||
```sh
|
||||
$ mkdir static
|
||||
$ python3 app.py
|
||||
```
|
||||
Open link `http://127.0.0.1:5000` in web browser
|
||||
|
||||
### Primary modules
|
||||
|
||||
`QuoteEngine`: Meme engine module for handling the generation of meme images.\
|
||||
`MemeEngine`: QuoteModel module for representing a quote with its body and author.
|
||||
|
||||
### Sub modules
|
||||
|
||||
`CSVIngestor`: Module for ingesting CSV files containing quotes. \
|
||||
`DocxIngestor`: Module for ingesting Docx files containing quotes. \
|
||||
`TextIngestor`: Module for ingesting text files containing quotes. \
|
||||
`PDFIngestor`: Module for ingesting PDF files containing quotes.
|
||||
Reference in New Issue
Block a user