Skip to content

Looking for Library API documentation #90

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.

Sign up for GitHub

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

Jump to bottom
Open
kolban-google opened this issue Mar 7, 2025 · 1 comment
Open

Looking for Library API documentation #90

kolban-google opened this issue Mar 7, 2025 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@kolban-google
Copy link

I am considering using this library in a project but I can't seem to find any of the API documentation. Where should I look to find documentation on methods such as:

  • celpy.Environment()
  • compile()
  • program()
  • json_to_cel
  • all the others ...

The examples in the README are great, but I am having trouble getting bootstrapped.
@kapilt
Copy link
Collaborator

kapilt commented May 5, 2025

beyond the readme, there are some sphinx docs in the docs folder, probably the most relevant one is
https://github.com/cloud-custodian/cel-python/blob/main/docs/source/integration.rst

@slott56 slott56 added the documentation Improvements or additions to documentation label May 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@kapilt @slott56 @kolban-google