Streamline CI/CD Workflows

[DeepBlockDeepak]

Overview

Adding consistency and efficiency to Dev + CI/CD processes, pyproject.toml and .github/workflows/main.yml need to be updated to better integrate Poetry's capabilities with existing GitHub Actions workflow. This will simplify running tests, linting, and formatting (both locally and in CI/CD too).

Tasks

pyproject.toml Updates -> :

• [x] add custom script commands for formatting, linting, and testing.
• [x] then make combined script (all-checks) for running all checks in one go.

.github/workflows/main.yml Updates -> :

• [x] update CI/CD steps to use the custom script commands defined in pyproject.toml.
• [x] CI/CD workflows should reflect the same standards and commands used in local development.

README and CONTRIBUTING Updates -> :

• [x] Update the README.md to include new commands for running tests, linting, and formatting code.
• [x] update or remove references to old processes.

Benefits :

• Consistency! : aligns local dev commands with CI/CD checks.
• Efficiency! : simplifies running individual checks before commits and on CI/CD.
• Maintainability! : centralizes command definitions, making future updates easier.

Concerns :

• Considerations for handling workflow failures, especially with respect to formatting checks.
• Potential impacts on development workflow and contributions.

Action :

• Draft and review changes to pyproject.toml and .github/workflows/main.yml.
• Test the implementation in a feature branch.
• Review and merge changes into main after successful testing and approval.

[DeepBlockDeepak]

ADDITIONAL UPDATE TO MAKE #22 Possible. I've restructured the project into a proper Python package to resolve issues with running poetry scripts as defined in pyproject.toml's tools.poetry.scripts. This reorganization was necessary for poetry to correctly recognize and execute the custom dev_tools scripts for formatting, linting, and testing. The restructuring involved creating a new package directory, kaggle_titanic, within src, moving relevant modules into this package, and updating import paths accordingly. As a result, commands like poetry run format, poetry run lint, poetry run test, and poetry run all-checks now function as intended, streamlining development workflow significantly.