Add type hinting and documentation to Python module

VirusTotal / yara-x

A rewrite of YARA in Rust.

https://virustotal.github.io/yara-x/

BSD 3-Clause "New" or "Revised" License

620 stars 48 forks source link

Add type hinting and documentation to Python module #178

Open tubarao312 opened 1 month ago

tubarao312 commented 1 month ago

In the documentation for PyO3, they give an example of how to add type hints to Python. I'd personally find this very useful: https://pyo3.rs/v0.22.2/python-typing-hints

I've worked with PyO3 and Python before, if you want I can do this myself and open a PR with type hints as well as docs and examples copied from the official documentation. Let me know if my help out be appreciated!

plusvic commented 4 weeks ago

Sure! This contribution is appreciated, if you want to work on that and send a PR, it's welcomed.