Document public Rust API

[radumarias]

Ideally we would want to see the public API and docs when the module is access from Python.
https://pypi.org/project/pyo3-stubgen/

Maybe this helps PyO3/pyo3#2330

If that is not possible alternatively we can document in readme file the public API from https://github.com/radumarias/rencrypt-python/tree/main/src
similar to
https://github.com/radumarias/rencrypt-python?tab=readme-ov-file#providers
https://github.com/radumarias/rencrypt-python?tab=readme-ov-file#algorithms

This is intended for Python devs which use the API. You can also include short Python examples code in doc.

Similar issue

• Document public Rust API zeroize-python#5
• added pyi docstrings zeroize-python#11

[m-rit]

Hi @radumarias, I came across this project while searching for crypto projects to contribute. Can I take this up if no one is assigned ?
Thanks!

[radumarias]

Hi, sure, you can take it, let me add you to the project. Can we connect in Discord? Somebody is working on a similar issue on another project and would help to coordinate with him, please connect me https://xorio.rs/

[radumarias]

@m-rit https://github.com/radumarias/rencrypt-python/invitations