Skip to content

dzhang32/rightprice

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

60 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

rightprice

test_deploy codecov pypi

rightprice helps you decide whether the property you want to buy is worth the price by retrieving the prices of sold houses.

Installation

I recommend using uv to manage the Python version, virtual environment and rightprice installation:

uv venv --python 3.13
source .venv/bin/activate
uv pip install rightprice

Usage

rightprice retrieves sold property prices for a given UK postcode. rightprice is designed to be used as a CLI tool, with a single command:

> rightprice retrieve-sold-prices --help
Usage: rightprice retrieve-sold-prices [OPTIONS]

  Retrieve sold property prices for a given postcode.

Options:
  -p, --postcode TEXT    UK postcode to search for sold prices.  [required]
  --radius FLOAT         Search radius in miles. Valid values: 0.25, 0.5, 1,
                         3, 5, 10.
  --years INTEGER        Number of years back to search. Valid values: 2, 3,
                         5, 10, 15, 20.
  -o, --output-dir PATH  Output directory. Defaults to current directory.
  --help                 Show this message and exit.

Output Format

The output .csv will be named based on the input parameters (e.g., se3-0aa_radius-0.5_years-5.csv) and contain the following columns:

address property_type n_bedrooms date price
123 Main Street, London Semi-Detached 3 15 Jan 2024 575000
45 Park Road, London Terraced 2 03 Dec 2023 425000
78 High Street, London Detached 4 22 Nov 2023 750000

Disclaimer

rightprice is developed for educational use only. Users are responsible for:

  • Following website's robots.txt and Terms of Service.
  • Using appropriate delays and respecting rate limits.
  • Complying with applicable laws.

About

Retrieve the prices of sold houses in the UK

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages