FAQ
Frequently Asked Questions¶
Q: Where can I find more information about the CRIPT data model?
A: Please feel free to review the CRIPT data model document and the CRIPT research paper
Q: What does this error mean?
A: Please visit the Exceptions documentation
Q: Where do I report an issue that I encountered?
A: Please feel free to report issues to our GitHub repository. We are always looking for ways to improve and create software that is a joy to use!
Q: Where can I find more CRIPT examples?
A: Please visit CRIPT Scripts where there are many CRIPT examples ranging from CRIPT graphs drawn out from research papers, Python scripts, TypeScript scripts, and more!
Q: Where can I find more example code?
A: We have written a lot of tests for our software, and if needed, those tests can be referred to as example code to work with the Python SDK software. The Python SDK tests are located within the GitHub repository/tests, and there they are broken down to different kinds of tests
Q: How can I contribute to this project?
A: We would love to have you contribute! Please read our contributing guidelines and our code of conduct to get started. Feel free to contribute to any bugs you find, any issues within the GitHub repository, or any features you want.
Q: This repository is awesome, how can I build a plugin to add to it?
A: We have built this code with plugins in mind! Please visit the CRIPT Python SDK GitHub repository Wiki tab for developer documentation.
Q: Is there documentation detailing the internal workings of the code?
A: Absolutely! For an in-depth look at the CRIPT Python SDK code, consult the GitHub repository wiki internal documentation.
Q: I have this question that is not covered anywhere, where can I ask it?
A: Please visit the CRIPT Python SDK repository and ask your question within the discussions tab Q/A section
Q: Where is the best place where I can contact the CRIPT Python SDK team for questions or support?
A: We would love to hear from you! Please visit our CRIPT Python SDK Repository GitHub Discussions to easily send us questions. Our repository's issue page is also another good way to let us know about any issues or suggestions you might have. A GitHub account is required.
Q: How can I report security issues?
A: Please visit the CRIPT Python SDK GitHub repository security tab for any security issues.
Q: Where can I find the release notes for each SDK version?
A: The release notes can be found on our CRIPT Python SDK repository releases section
Q: Besides the user documentation, is there any developer documentation that I can read through on how the code is written to get a better grasp of it?
A: You bet! There are documentation for developers within the CRIPT Python SDK Wiki. There you will find documentation on everything from how our code is structure, how we aim to write our documentation, CI/CD, and more.
We try to also have type hinting, comments, and docstrings for all the code that we work on so it is clear and easy for anyone reading it to easily understand.
if all else fails, contact us on our GitHub Repository.