Cleaned up UI + replaced json config files with toml + fixed kafka local runs.#249
Merged
Cleaned up UI + replaced json config files with toml + fixed kafka local runs.#249
Conversation
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 several improvements and refactorings to the FastAPI template project, focusing on better configuration management, modernization of the project generation hooks, and enhancements to the documentation and environment setup. The most significant changes include switching from JSON to TOML for manifest files, improving the post-generation project setup, updating Docker documentation for consistency, and enhancing the
.envand test instructions for new features and services.Configuration and manifest improvements:
conditional_files.json→conditional_files.toml,replaceable_files.json→replaceable_files.toml) for improved readability and maintainability. Updated all related code inpost_gen_project.pyto use TOML parsing withtomllibinstead of JSON. [1] [2] [3]Project generation and hook enhancements:
post_gen_project.pyhook to usePathobjects for file operations, added a reusablerun_cmdfunction for better subprocess error handling and output, and enhanced theinit_repofunction with improved logging, error handling, and repeated pre-commit runs for robustness. [1] [2]generate_projectfunction in__main__.pyto usedefault_config=Trueforcookiecutter, simplifying the configuration process.Documentation and Docker usage improvements:
README.mdto use the moderndocker composesyntax instead of the deprecateddocker-compose, and clarified instructions for running auxiliary services and tests, making the documentation more accurate and user-friendly. [1] [2] [3]Environment and feature support:
.envtemplate to support Kafka by adding a conditional environment variable when Kafka is enabled.Code style and cleanup:
__main__.py.