Skip to content

Restructure Into Normal Python Module Structure

Closed Jun 25, 2024 100% complete

This work is for the development to restructure Sherlock so that it follows the normal Python module structure.

Here is a proposal of what the Sherlock repository would look like if it was cloned on a developer's machine after this milestone has been done:

sherlock/
    .git/
    LICENSE
    README.md
    setup.py
    sherlock/
        __init__.py
       …

This work is for the development to restructure Sherlock so that it follows the normal Python module structure.

Here is a proposal of what the Sherlock repository would look like if it was cloned on a developer's machine after this milestone has been done:

sherlock/
    .git/
    LICENSE
    README.md
    setup.py
    sherlock/
        __init__.py
        find.py
        tests/
            __init__.py
            release.py

The find.py would have the search/scan logic that is the heart of the tool. This would also leave the structure open if other features were added in the future.

I am not sure how the data.json file fits into this. I am not sure how a packaged module understands the path to a random JSON file stored in the file system. Perhaps we will put the data.json file into a completely different area.

This milestone is closed.

No open issues remain. View closed issues or see open milestones in this repository.