davidackroyd99 / content_miner Goto Github PK

• Main screen has button to purge duplicates from wordlist
• Clicking it removes duplicate terms from the wordlist chosen on the main GUI

Before V0.1 public release, there should be a video in the README that quickly shows people how the software works

The output needs to show some stats about how long the process took so that performance can be measured and improved.

• Simple asset statements in an if __name__ == '__main__' section of each file
• Make sure that these tests can be run for the project automatically by PyCharm or similar

When the gui loads, it will remember the filepaths previously used.

• Tick box to enter 'scan mode'
• 'Scan mode' is called something better (maybe 'targets only'?)
• Main screen has textbox for allowed number of unknown targets (default 1)
• Tick box for whether or not we want target frequency after target in the output

Create some kind of GUI installer that works on Windows so that people can download V0.1 off GitHub and try it out.

Might help:
https://stackoverflow.com/questions/9960583/how-do-you-make-an-installer-for-your-python-program

Some sort of error message pops up if the user doesn't enter all the required fields/number fields are not numbers

• Software actually works as a console app rather than some janky Python script
• Command line arguments for wordlist and content
• Switch for scan mode (default false)
• Switch for adding target frequency (default true)

.srt files are cleaned of subtitle crap before being imported (may involve an extra dependency)

• GUI opens when application is run from cmd line
• Main screen has textbox for known wordlist filepath (required field)
• Main screen has textbox for content filepath (required field)
• Main screen has textbox for destination filepath (required field)
• Main screen has button marked 'Find Sentences'
• Clicking 'find sentences' will execute the existing sentence finding functionality and save the result to the destination filepath

• Explore layout/theming w/ TTK
• All the elements are lined up in some sort of layout that doesn't look ridiculous
• Window heading (next to minimize, exit, etc.) shows name and version number

Any I/O issues are gracefully handled and the user gets a message letting them know what went wrong.

• Dev pipeline which lints & runs the tests (to be run before PRs are merged)
• Release pipeline which lints, runs the tests and creates the installer

• Have proper .gitignore
• Only contain files for software, no personal wordlists or content

Because the process takes a vaguely long time, the user will want to know how far through they are and that the app is actually doing something.

• The code needs to be organised into separate files (not all just in main.py)
• Public/private functions
• Docstring at the top of each file, roughly explaining scope
• Docstring for each public function
• Also need type hints