Title: Improve Python Code Formatting and Organization
Resolves #1
Description:
This pull request introduces improvements to the Python code formatting and organization in our "Hello World" application. We've integrated black for code formatting and isort for import organization.
Changes:
Updated main.py to demonstrate the effects of black and isort.
Added instructions to README.md on how to use black and isort.
Instructions for Reviewer:
Checkout to this branch by opening it in GitHub Codespaces. If you are reading this you simply click the period key on your keyboard and it will open up this pull request in GitHub Codespaces. There is also a button on the top right that says <> Code with a dropdown that allows you to also open up a GitHub Codespace. (Please also read the README.md there are setings you should set to maximize your GitHub Codespace usage on your account.)
Open the main.py file located in src directory by clicking once on it. You will need to use the explorer. The Explorer button is the topmost icon on the left sidebar, it looks like two stacked documents. Below it, you'll find other icons for Search (magnifying glass), Source Control (branching diagram), Run (play arrow), and Extensions (square within a square).
Open the integrated terminal in VS Code. You can do this by clicking on Terminal in the top menu, then New Terminal.
In the terminal, run black and isort on the main.py file:
black src/main.py
isort src/main.py
These commands will format the code and organize the imports in main.py. Notice that the main.py file has been edited.
Run the main.py script:
python src/main.py
This command will run the script and generate a log.txt file.
Open the log.txt file and copy its contents. You can open the file by clicking on it in the Explorer on the left side of VS Code.
Paste the contents of the log.txt file in your review comment on this pull request to validate that you have run the code successfully.
Acceptance Criteria:
The main.py script runs successfully.
The log.txt file contains the expected output.
The code in main.py is well-formatted and the imports are well-organized.
Title: Improve Python Code Formatting and Organization
Resolves #1
Description:
This pull request introduces improvements to the Python code formatting and organization in our "Hello World" application. We've integrated
blackfor code formatting andisortfor import organization.Changes:
main.pyto demonstrate the effects ofblackandisort.blackandisort.Instructions for Reviewer:
Checkout to this branch by opening it in GitHub Codespaces. If you are reading this you simply click the period key on your keyboard and it will open up this pull request in GitHub Codespaces. There is also a button on the top right that says <> Code with a dropdown that allows you to also open up a GitHub Codespace. (Please also read the README.md there are setings you should set to maximize your GitHub Codespace usage on your account.)
Open the main.py file located in src directory by clicking once on it. You will need to use the explorer. The Explorer button is the topmost icon on the left sidebar, it looks like two stacked documents. Below it, you'll find other icons for Search (magnifying glass), Source Control (branching diagram), Run (play arrow), and Extensions (square within a square).
Open the integrated terminal in VS Code. You can do this by clicking on
Terminalin the top menu, thenNew Terminal.In the terminal, run
blackandisorton themain.pyfile:These commands will format the code and organize the imports in
main.py. Notice that the main.py file has been edited.Run the
main.pyscript:This command will run the script and generate a
log.txtfile.Open the
log.txtfile and copy its contents. You can open the file by clicking on it in the Explorer on the left side of VS Code.Paste the contents of the
log.txtfile in your review comment on this pull request to validate that you have run the code successfully.Acceptance Criteria:
main.pyscript runs successfully.log.txtfile contains the expected output.main.pyis well-formatted and the imports are well-organized.