feat: Add Pydantic types generator and run script for Circuit JSON#374
Open
Devesh36 wants to merge 1 commit intotscircuit:mainfrom
Open
feat: Add Pydantic types generator and run script for Circuit JSON#374Devesh36 wants to merge 1 commit intotscircuit:mainfrom
Devesh36 wants to merge 1 commit intotscircuit:mainfrom
Conversation
rushabhcodes
left a comment
There was a problem hiding this comment.
I don't think this solves the issue
Author
wip |
Contributor
|
not accepting contributions like this from non-maintainers because you need to have a history of maintaining complex solutions |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces a new workflow for generating Python Pydantic models from the Circuit JSON TypeScript definitions. It adds scripts and commands to automate the creation of Python type files, including utility functions and sample types, and organizes the generated code into a structured Python package.
Python Pydantic type generation:
scripts/generate-pydantic-types.tsthat generates Python files with Pydantic models and utility functions for Circuit JSON types, including PCB and source component models, as well as unit conversion utilities. The script creates a well-organized directory structure underpython/for the generated files.scripts/run-pydantic-generator.tsto execute the Pydantic types generator and print out the resulting directory structure and usage instructions.Build and workflow enhancements:
package.jsonto add new scripts:generate-pydantic(runs the Python types generator) andgenerate-all(runs both the Python types and documentation generators)./fix #90