sherlock icon indicating copy to clipboard operation
sherlock copied to clipboard

sherlock as a python library

Open peterclemenko opened this issue 1 year ago • 1 comments

Description

being able to use sherlock as a library in python scripts would be helpful for automation flows

Code of Conduct

  • [X] I agree to follow this project's Code of Conduct

peterclemenko avatar Sep 12 '24 05:09 peterclemenko

Already doable!

I've done the same as a dependency of Sylva (ongoing). You can see how it was implemented here.

I have plans to clean up the imports a bit, so that you can do from sherlock_project ... rather than from sherlock_project.sherlock ..., but that's down the line. Type defs are mostly there if you use static type validation, with #2277 (soon, need to push a change) set to add ~proper~ support for type checks with things like mypy.

Proper documentation for use as a dependency will probably be added at some point.

ppfeister avatar Sep 12 '24 20:09 ppfeister