Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document public Rust API #4

Open
radumarias opened this issue Jul 30, 2024 · 3 comments
Open

Document public Rust API #4

radumarias opened this issue Jul 30, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@radumarias
Copy link
Owner

radumarias commented Jul 30, 2024

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

@radumarias radumarias added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jul 30, 2024
@radumarias radumarias moved this to Todo in rencrypt-python Jul 30, 2024
@m-rit
Copy link
Collaborator

m-rit commented Aug 4, 2024

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
Copy link
Owner Author

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
Copy link
Owner Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
Status: Todo
Development

No branches or pull requests

2 participants