Skip to main content

realestatebot

tool for ripping Australian real estate listings

version status downloads

license format pyversions

repo-size code-size

summary

uses realestate-data to rip listings from realestate.com.au

this module has not been properly tested, and as such, deviating too far from the examples counts as misuse, and may cause unpredicatable behaviour

i made this for personal use, and i'm sharing it in case someone else finds it useful

setup

git clone https://github.com/silvncr/realestatebot.git

.env (example)

    # comma-separated lists; no spaces; required

POSTCODES="2600,2601,2602"         # main search parameter; more can be added
STATES="ACT,NSW,VIC,QLD,NT,SA,TAS"  # WA is not supported (not sure why)

    # target location (for distance calculations); not required, can be omitted

# idk where this is btw
TARGET_LAT=-35.308056  # latitude (in decimal degrees north)
TARGET_LON=149.124444  # longitude (in decimal degrees east)

    # price range (in AUD); not required, can be omitted; defaults shown below

PRICE_MIN=10000    # minimum price; not validated in-app; can be zero
PRICE_MAX=10000000  # maximum price; not validated in-app

run

cd realestatebot

    # make sure to set up `.env` before running

pip install -r requirements.txt
python realestatebot/__init__.py

library

this is a library, so you can use it in your own projects

pip install realestatebot

try it yourself with this example

from json import dump
from os   import path as os_path
from sys  import path as sys_path

from realestatebot import main

with open(os_path.join(sys_path[0], 'out.json'), 'w') as file:
    dump(
        main(

            postcodes   = {2600},
            states      = {'ACT'},
            target      = (-35.308056, 149.124444),
            price_range = (10_000, 10_000_000),

        )[0].to_dict(orient="records"), file, indent=4
    )

print('\ndone')

todo

feature basic better finished
code comments x
code quality x
documentation x
error handling x
examples x
logging x
modulation x
output formats x
performance x
reliability x
requirements x
search parameters x
security x
tests x

Metadata

Release files for realestatebot 0.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for realestatebot 0.0.2
File Size Uploaded Provenance Actions
realestatebot-0.0.2.tar.gz 7.3 kB Without provenance Details for realestatebot-0.0.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for realestatebot 0.0.2
File Interpreter ABI Platform Actions
realestatebot-0.0.2-py3-none-any.whl Python 3 none any Details for realestatebot-0.0.2-py3-none-any.whl

Total release size: 14.9 kB

Release files / realestatebot-0.0.2.tar.gz

Download URL realestatebot-0.0.2.tar.gz
Size 7.3 kB
Tags Source
SHA-256 checksum
How to use checksums
b6e12c173dadfbba7ad7afb169b03293fb8f2c9a4641c0635f2bbf1df3a33501
BLAKE2b-256 checksum
How to use checksums
1f9396b1e4ad5dfa38bebd6d38dbc8241f21e4ba3b8f48c948e93b23229ada57
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.9.19

Release files / realestatebot-0.0.2-py3-none-any.whl

Download URL realestatebot-0.0.2-py3-none-any.whl
Size 7.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
82f3c75e69a8e6bfc69ed0a4cdc344270c8547ae992ef1251c64f34ce656fb7a
BLAKE2b-256 checksum
How to use checksums
2ef80a69a8f9868c684caf644829c9b58d77ff871fb51c403dca02e67ae2f29d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.9.19

Security for realestatebot 0.0.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.2 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page