r3nt0n / bopscrk

Generate smart and powerful wordlists
https://pypi.org/project/bopscrk
GNU General Public License v3.0
856 stars 109 forks source link

[WIP] refactor #19

Closed noraj closed 2 years ago

noraj commented 2 years ago
r3nt0n commented 2 years ago

Thank you @noraj ,

Checking this changes looks like you have renamed modulesto bopscrk instead of git mv modules bopscrk and it broke reference to lyricpass in .gitmodules, so this submodule was deleted in your draft. All the other references (imports) should be broken too. I think we should follow these steps:

  1. Properly rename modules to bopscrk to keep all references, including submodule lyricpass. When this refactor is complete, we will have address bullets 1 and 2 from #18

  2. To EXCLUDE all cache files, and INCLUDE the bopscrk.cfg file Im writing a MANIFEST.in, but I have doubts, I dont know the path where included files will be stored by pip install and how the main script will find the .cfg file.

  3. To EXCLUDE test packages and avoid get_packages(), we need to set this required packages ['bopscrk', 'bopscrk.lyricpass']

This changes should adress bullets 3, 4 and 5 from #18.

After this, I should review the code to catch some exceptions and alert the user when no cfg file is found, and maybe establish some default values in config.py where is possible.