Skip to main content

What is the right price for your property of interest?

Project description

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] POSTCODE

  Retrieve sold property prices for a given postcode.

Options:
  --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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rightprice-0.1.0.tar.gz (302.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rightprice-0.1.0-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

Details for the file rightprice-0.1.0.tar.gz.

File metadata

  • Download URL: rightprice-0.1.0.tar.gz
  • Upload date:
  • Size: 302.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for rightprice-0.1.0.tar.gz
Algorithm Hash digest
SHA256 a8097bcc73d6d3e123251b97f3e94cf2e1f118d92b15356dde9978e257865753
MD5 d1419b6a31d21b0b04a015c5e6382d59
BLAKE2b-256 59e30e49078b5a335545e82c62a63ce8f8e01270488e90ef9e3095592b4aa64b

See more details on using hashes here.

Provenance

The following attestation bundles were made for rightprice-0.1.0.tar.gz:

Publisher: test_deploy.yml on dzhang32/rightprice

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file rightprice-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: rightprice-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 8.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for rightprice-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 70c9e6bc116f8aab6b2c8446bae03b0d1460734014d9874de9c18f4b9fea65e0
MD5 8e60f40613c89003e359ec7404ec5707
BLAKE2b-256 cc03666d1e7489b150b8ff9a5dbcf33d82c26aedadadb763a56da1aa3d467911

See more details on using hashes here.

Provenance

The following attestation bundles were made for rightprice-0.1.0-py3-none-any.whl:

Publisher: test_deploy.yml on dzhang32/rightprice

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page