-
Notifications
You must be signed in to change notification settings - Fork 36
Tutorial for Pydantic validation #812
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
base: main
Are you sure you want to change the base?
Conversation
|
@tomdemeyere thanks! To me, this looks already great. @utf do you have any comments? I have two points I am wondering about: |
|
Thanks for this @tomdemeyere. I think it looks great. As @JaGeo said, if you can add a little more motivation to why this is useful that would be perfect. For now, I think the position in the documentation is OK. We might need to do a more thorough adjustment later on. |
|
Thank you both for the feedback, I've added some context at the beginning of the notebook |
|
@tomdemeyere From my side, the context sounds good. You could additionally refer to atomate2 as a package where this is used |
|
@JaGeo That makes sense, done! |
|
@utf are you fine with the current status? Should we merge this? |
|
@utf kind reminder 🙂. Workflows would beed to be approved. |
Summary
Small tutorial about Pydantic validation and how it can be used with jobflow, please let me know if I should add anything else
#808 @JaGeo @utf
The easiest way to handle this is to run the following in the correct sequence on
your local machine. Start with running black on your new code. This will
automatically reformat your code to PEP8 conventions and removes most issues. Then run
pycodestyle, followed by flake8.
Run pydocstyle on your code.
type check your code.