pyBookBot

depends on macOS/linux, python >= 3.7, pytest, bash/zsh, file, curl, touch, rm

• pip install -r requirements.txt for python requirements

running and testing

• assuming local shell environment command for python interpreter is python
• run program in shell with: python pyBookBot.py run
  • downloads books/, runs the program, and outputs results to reports/
• run tests with: python pyBookBot.py test
  • runs tests and cleans up books/ and reports/

description

• A boot.dev guided project.
  • everything after commit id 432051146baee1c38fc5c0cafc54271e21138107 are features added beyond scope of project.
• features added beyond scope of project:
  • pyBookBot generates reports for more than one book and writes the reports to a file in reports/
  • added unit tests to pyBookBot
    • tests can be run in a shell via ./test.sh
    • checks if a books/ directory exists with at least one book to write a report on
    • tests if all data structures are created correctly
    • tests if all output to reports from downloaded sources has not changed
    • checks if books are .txt files before generating a report
    • added check for mime type using sys command file (if current OS does not have file, mime type test will fail)
    • pyBookBot also checks the reports and error messages that should be generated.

to do

• refactor all cleanup commands into single cleanup.sh file and call where needed
• add pythonic prepPyBookBot.py module to run python pyBookBot.py run
• convert prep.sh, test.sh, reports_setup.sh, test_helper0.sh, test_helper1.sh, and cleanup.sh to python modules
• take source download link and filename from user
• add main and test option to cli with shell implementation
• determine if downloaded file is a text file (bytecode?), go above and beyond extension checking
• use main idiom on line 81
• change main.py to pyBookBot.py