Housing Price Predictor

The repository below will consist of an application that predicts housing prices using historical data. This project uses python and poetry for dependency management, and includes tests to ensure the functionality is correct.

Step 1

If you haven't already intall the following:

• Download Python 3.12.
• Download Poetry for dependency management.

Step 2

1. Fork the Repository:

   • Fork this repository to your GitHub account.

2. Clone the Repository:

   • Clone the forked repository to your local machine:

     git clone https://github.com/YOUR-USERNAME/housing_price_predictor.git
     cd housing_price_predictor
     

3. Install Dependencies:

   • Install the project dependencies using Poetry:

     poetry install
     

     python -m poetry add sphinx pytest ruff
     
     

4. Activate the Poetry Environment:

   • Activate the Poetry virtual environment:

     poetry shell

Step 3

In order to run Python, read this final step to ensure installation.

1. In GitBash open the projects directory.

   cd housing_price_predictor/housing_price_predictor

2. Run python: Execute the main script: sh python main.py

3. Expected Output: You should see the product of the Multiplication Function, which is a part of the dummy method for demonstration purposes:

   *****************
   
   

Conclusion

After reading this file you should understand how to set up the repositroy and run the application on your local machine.