Skip to content

Commit

Permalink
Update setup document
Browse files Browse the repository at this point in the history
  • Loading branch information
ChristopherChristofi committed Aug 24, 2021
1 parent 747a958 commit baa66c0
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 12 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ The response data consists of:
The most amount of data you can collect is limited by the page counts set by the RightMove website, this same limitation is enforced in PropertyListings so you don't have to needlessly continue searching if all has been retrieved. It is important to note that not all sales records are visible even on the website itself, at most there is 40+ pages per search and that is around 1000 to 1100 property records.
All the filter parameters that build the search query function in a PropertyListinngs command can include:
All the filter parameters that build the search query function in a PropertyListings command can include:
- set pages
- set region
- set maximum and minimum bedroom counts
Expand All @@ -90,12 +90,14 @@ An example that uses a lot of these search parameters can be found here:
propertylistings --save-file search --pages 30 --region devon --max-beds 8 --min-beds 6 --new-home, --no-retirement --offer-sold
```
Returning sales property records based in Devon, that have bedroom count between 8 and 6, is a new build, is not a retirement property, and the data can also include properties under offer or already sold.
Returning sales property records based in Devon, that has a bedroom count between 8 and 6, is a new build, is not a retirement property, and the data can also include properties under offer or already sold.
Due to the copius amounts of regions and their own subregions again, not every existing RightMove region is available directly through the PropertyListings '--region' option, although, there are plans to continue adding more batches of regions, for now London and other areas around the United Kingdom are available; however, if you cannot find yours on the list (which you find using the help example from above) you are able to add a region temporarily via the '--add-region' option of the main command, which can see below:
Due to the copius amounts of regions and their own subregions again, not every existing RightMove region is available directly through the PropertyListings '--region' option, although, there are plans to continue adding more batches of regions, for now London and other areas around the United Kingdom are available; however, if you cannot find yours on the list (which you find using the help example from above) you are able to add a region temporarily via the '--add-region' option of the main command, which you can see below:
```sh
propertylistings --save-file --add-region 813 search --pages 22 --max-price 750000 --max-days 7 --auction
```
The '813' is an example region code for RightMove that will search properties found in 'Liverpool'. With regards to the other options in this search query command, all property data returned will have a maximum price value of £750,000, will have been added within the past 7 days, and will be an auction property.
The '813' is an example region code for RightMove that will search properties found in 'Liverpool'. With regards to the other options in this search query command, all property data returned will have a maximum price value of £750,000, will have been added within the past 7 days, and will be an auction property.
Thank you and good luck.
7 changes: 3 additions & 4 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
[metadata]
name = propertylistings
version = 0.1.8
version = 0.1.0
author = Christopher Christofi
author_email = [email protected]
description = Webscraping tool for archiving sales records on RightMove.
long_description = file: README.md
long_description_content_type = text/markdown
url = https://github.com/christopher-christofi/listings
url = https://github.com/christopher-christofi/propertylistings
project_urls =
Bug Tracker = https://github.com/christopher-christofi/listings/issues
Bug Tracker = https://github.com/christopher-christofi/propertylistings/issues
classifiers =
Development Status :: 3 - Alpha
License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Operating System :: OS Independent
Programming Language :: Python :: 3
Expand Down
7 changes: 3 additions & 4 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,16 @@
if __name__ == "__main__":
setuptools.setup(
name='propertylistings',
version='0.1.9',
version='0.1.0',
author='Christopher Christofi',
author_email='[email protected]',
license='GPL-3.0',
description='Webscraping tool for archiving sales records on RightMove.',
long_description=long_description,
long_description_content_type="text/markdown",
url='https://github.com/christopher-christofi/listings',
url='https://github.com/christopher-christofi/propertylistings',
project_urls={
"Bug Tracker": "https://github.com/christopher-christofi/listings/issues",
"Bug Tracker": "https://github.com/christopher-christofi/propertylistings/issues",
},
packages=setuptools.find_packages(),
include_package_data=True,
Expand All @@ -31,7 +31,6 @@
],
},
classifiers=[
'Development Status :: 3 - Alpha',
'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
'Operating System :: OS Independent',
'Programming Language :: Python :: 3',
Expand Down

0 comments on commit baa66c0

Please sign in to comment.