{
    "info": {
        "author": "Jeremy Storer",
        "author_email": "storerjeremy@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "License :: OSI Approved :: MIT License",
            "Operating System :: OS Independent",
            "Programming Language :: Python :: 3"
        ],
        "description": "# Realestate Data\n\nA tool to request real estate data from an unofficial realestate.com.au\n\"API\".\n\n## Installation\n\n```bash\npip install realestate-data\n```\n\n## Usage\n\nBuild out schematics to represent the search query you are after.\n\nSee [here](https://webtools.realestate.com.au/configuring-widgets-included-via-javascript/)\nfor available options, or take a look at ./realestate_data/schematics.py\n\nThe below creates a search object that represents\n- Units and apartments for sale\n- in Melbourne Victoria, 3000\n- and surrounding suburbs\n- price between $500,000 and $1,000,000\n- minimum of 1 parking space\n- minimum of 1 bathroom\n- minimum of 2 bedrooms\n\n```python\n>>> from realestate_data import Search, Locality, PriceRange, Filters\n>>>\n>>> p = PriceRange()\n>>> p.minimum = 500000\n>>> p.maximum = 1000000\n>>>\n>>> l = Locality()\n>>> l.locality = 'Melbourne'\n>>> l.subdivision = Locality.SUBDIVISION_VIC\n>>> l.postcode = '3000'\n>>>\n>>> f = Filters()\n>>> f.property_types = [Filters.PROPERTY_TYPE_APARTMENT, Filters.PROPERTY_TYPE_UNIT]\n>>> f.surrounding_suburbs = True\n>>> f.minimum_bedrooms = 2\n>>> f.minimum_bathrooms = 1\n>>> f.minimum_parking_spaces = 1\n>>> f.price_range = p\n>>>\n>>> s.channel = Search.CHANNEL_BUY\n>>> s.localities = [l]\n>>> s.filters = f\n```\n\nCall validate() on the search object to ensure its valid. It will return\nnothing if valid and an error if not\n\n```python\n>>> s.validate()\n```\n\nCall to_primitive() to view the search object\n\n```python\n>>> s.to_primitive()\n{'channel': 'buy', 'localities': [{'locality': 'Melbourne', 'subdivision': 'VIC', 'postcode': '3000'}], 'filters': {'property-types': ['apartment', 'unit'], 'minimum-bedrooms': 1, 'minimum-bathrooms': 1, 'minimum-parking-spaces': 1, 'surrounding-suburbs': True, 'price-range': {'minimum': 500000, 'maximum': 1000000}}}\n```\n\nPass the created Search object to the paged_results generator. The generator\nyields the json returned from each paged request.\n\n```python\n>>> from realestate_data import paged_results\n>>> paged_data = [page for page in paged_results(s)]\n```\n\nOr use the Generator how ever you want\n\n```python\n>>> paged_data = paged_results(s)\n>>> page_one = next(paged_data)\n>>> page_two = next(paged_data)\n```\n\n```python\n>>> for page in paged_results(s):\n>>>     print(page)\n```\n\n## Todo\n\n- Testing\n\n## Author\n\nJeremy Storer <storerjeremy@gmail.com>",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/storerjeremy/realestate-data",
        "keywords": "",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "realestate-data",
        "package_url": "https://pypi.org/project/realestate-data/",
        "platform": "",
        "project_url": "https://pypi.org/project/realestate-data/",
        "project_urls": {
            "Homepage": "https://github.com/storerjeremy/realestate-data"
        },
        "release_url": "https://pypi.org/project/realestate-data/0.1.0/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "Realestate Data",
        "version": "0.1.0"
    },
    "last_serial": 4802777,
    "releases": {
        "0.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "56abdffac188f0722ee93cbe7f844d43",
                    "sha256": "99c7c2397c75ec14aabd3faff5e124b6ba6a927137b101e1fcfb351668f9a22e"
                },
                "downloads": -1,
                "filename": "realestate-data-0.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "56abdffac188f0722ee93cbe7f844d43",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4259,
                "upload_time": "2019-02-10T17:18:17",
                "url": "https://files.pythonhosted.org/packages/66/a8/5245be51f2d5753a386ff6ef7e3b812caf541407755a6072b740e95fa0fa/realestate-data-0.0.1.tar.gz"
            }
        ],
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "5ed3610624833cb767630ba8e946e419",
                    "sha256": "a2432abfa99eda4ac677d3b4775ba03715ae7b19a94f05819460410642f95411"
                },
                "downloads": -1,
                "filename": "realestate-data-0.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "5ed3610624833cb767630ba8e946e419",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4229,
                "upload_time": "2019-02-10T17:31:09",
                "url": "https://files.pythonhosted.org/packages/85/4e/49ec3f51f2932ed237b32437918f2513004799c64bc2639d3685f358694a/realestate-data-0.1.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "5ed3610624833cb767630ba8e946e419",
                "sha256": "a2432abfa99eda4ac677d3b4775ba03715ae7b19a94f05819460410642f95411"
            },
            "downloads": -1,
            "filename": "realestate-data-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "5ed3610624833cb767630ba8e946e419",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 4229,
            "upload_time": "2019-02-10T17:31:09",
            "url": "https://files.pythonhosted.org/packages/85/4e/49ec3f51f2932ed237b32437918f2513004799c64bc2639d3685f358694a/realestate-data-0.1.0.tar.gz"
        }
    ]
}