poiley / syllaborem Goto Github PK

Details

Feature Request

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I have an issue when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen. Add any considered drawbacks.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Teachability, Documentation, Adoption, Migration Strategy
If you can, explain how users will be able to use this and possibly write out a version the docs.
Maybe a screenshot or design?

Add functionality to the reader module to

1. • Read a PDF file in
2. • Output the PDF's contents as a plaintext to a text file

An init file is important for any package we write. It allows python interpreters to know that a folder contains a module and how it needs to handle that module. We need to write one for reader module.

https://github.com/sumn2u/react-materialize-admin-template/tree/master/src

We should replicate something like this for the front end as far as file layout

Create a yaml or json file in the reader module that can act as a template for what we'd like to parse a syllabus to.

Switch file reader

• Look up good python3 libraries that can read PDF files
• Determine the best one for our situation
• Import it in the reader module's core file
• Add it to requirements.txt

Set up parent class for Reader, outline any sub classes it needs and document it accordingly.

Critically needed for web development

Could be based on word frequency or something of the sort. Essentially note if something is common enough to possibly add as a section of the new template.