feat: restructure and standardize project scripts for portability and usability#43
Merged
feat: restructure and standardize project scripts for portability and usability#43
Conversation
…ty and clarity - Moved launcher scripts (`run.py`, `run.sh`, `run.bat`) to the `scripts` directory. - Enhanced script logic to resolve project root dynamically for better portability. - Adjusted virtual environment activation checks and error messages for clarity. - Updated FLASK_APP path to align with new project structure. - Standardized instructions for dependency setup across platforms.
- Moved `setup.bat`, `setup.sh`, and `setup.py` to the `scripts` directory. - Improved cross-platform compatibility and added dynamic path resolution for portability. - Enhanced dependency management logic to include `uv` installation and synchronization. - Updated instructions and error handling for clearer feedback during the setup process. - Incorporated `rich` for better logging and progress feedback in `setup.py`.
- Moved `make_release.py` to `scripts/` directory and adjusted paths for better alignment with the project structure. - Updated included and excluded files to match the new structure and reduce unnecessary files in releases. - Enhanced path-handling logic to dynamically resolve project root and preserve relative paths in releases. - Improved console feedback by refining progress display and error handling.
7e726fb to
527c449
Compare
| ) as progress: | ||
| task = progress.add_task(description, total=None) | ||
| try: | ||
| result = func(*args, **kwargs) |
Check warning
Code scanning / CodeQL
Use of the return value of a procedure Warning
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.
Summary
This PR restructures and enhances all project scripts to improve portability, consistency, and developer experience across platforms.
Changes
Script Organization
scripts/directory:run.py,run.sh,run.batsetup.py,setup.sh,setup.batmake_release.pyPortability Improvements
Setup & Dependency Management
uvinstallation and dependency synchronizationrichtosetup.pyfor improved logging and progress feedbackLauncher Enhancements
FLASK_APPpath to match new project structureRelease Script Improvements