TitleGenerator

This Python program was written by:

• Jacob Hillock (jmanh128)
• Tangeni Shikomba (dev-mtshikomba)
• Chisulo Mukabe (NuMellow)

For the COSC462 Introduction to Information Retrieval and Recommendor Systems class at Eastern Michigan University.

Our methodes include:

• Algorithms

Our sources include:

• Sources

Python version

• Python 3.8 recommended
• Currently testing Python 3.7

How to use python venv

Make venv

$ python -m venv [venv]

NOTE: [venv] can be whatever, I usually just leave it as "venv"

NOTE: if you don't name it as "venv" please add what ever you name it to the .gitignore and commit that

NOTE: this probably does not work with anaconda/conda, please use normal python.

Activate venv

MAC/LINUX: $ source venv/bin/activate

WINDOWS: venv\Scripts\Activate

Load requirements

$ pip install -r requirements.txt

NOTE: Make sure to activate the venv

Update requirements

$ pip freeze > requirements.txt

NOTE: Make sure the venv is activated

NOTE: Make sure to commit and push update

Download the nltk stopwords

$ python -m nltk.downloader stopwords

Updating this readme:

If you need to update the README.md, follow the style guide here:

https://help.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax

Using the Wikipedia webscrape:

1. Scrape:
   • if you wish to do a single scrape:
     • $ python wikipedia_scrape.py --article='[ARTICLE]'
   • if you wish to do a recursive scrape:
     • $ python wikipedia_scrape_rec.py --article='[ARTICLE]' [--depth=[n]]
     • depth is an optional field

Passing arguments from the terminal

• using the following command shows you all the arguments available for this tool:

$ python main.py -h

• The parameter below allows you scrape the web using keywords, the tools will scrape for a documents from wikipedia using the keyword "Artificial Intelligence", and saves the scraped content to a named text file and then title the article.

$ python main.py --article="ARTICLE"

• The parameter below allows you to title the given document.

$ python main.py --doc="DOC"

• The parameter below allows you to specify a length of the title (default: automatic 1 [A1])
  • 'A2' would generate a title of at least two words long
  • '2' would generate a title of exactly two words long

$ python main.py --length="LENGTH"

• The parameter below allows you to specify a words 'max score' (default: N)

$ python main.py --maxScore="MAXSCORE"