🟠 Review Project Configuration
Your project repository should be open in VS Code.
Step 1. Briefly Review the Configuration Files
In VS Code Explorer, review the configuration files in your project root. Common files include:
- pyproject.toml - configures the Python project
- .python-version - specifies the major Python version
- prek.toml - configures git hooks (automated checks)
- .editorconfig - configures the editor (so it works the same on all OS)
- .gitattributes - configures git file attributes (again for all OS)
- .gitignore - tells what not to keep in the project version history
- .pytest.toml - configures the test runner that tests project code
- .ruff.toml - configures project linting and formatting preferences
Not every project requires every configuration file. These are mostly silent helpers and don't need to be altered.
For additional information, see pyproject.toml.
Step 2. Review pyproject.toml
Open pyproject.toml and review its sections.
Optional: Update Project Identity Description and Version
- description - describe your project and what will make it unique.
- version - set this initial version of your project to something like 0.1.0.
Briefly Review Dependencies
- Review the packages listed in dependencies.
- Review the development and documentation dependency groups.
- Keep packages needed by the project.
- You can always add packages as you work.
Verification
- [ ] pyproject.toml exists in the project root.
- [ ] Dependencies and Python requirements have been reviewed.