Skip to main content

A package for filtering real estate opportunities based on your financial situation

This project has been archived.

The maintainers of this project have marked this project as archived. No new releases are expected.

Project description

CI Tests

Mortgage-Filter-Package

A Python package for processing real estate data frames that instantly yields an array of affordability information. Let's find our dream homes, enjoy!

Requirements

  • python >=3.7
  • pandas
  • numpy

Installation

$ pip install mortgage-filter-lukavuko

Check out the demo:

Click Here

Motivation

At some point in our live, we may consider buying a home. To do so, we'll sift through massive amounts of research and properties followed by calculating what's affordable and what isn't. How tedious. But wait... with the mortgage-filter-package, one can seamlessly filter through real estate opportunities based on one's financial circumstances.

The package is designed to filter property dataframes to yield the affordable ones and information regarding their affordability (monthly payments to minimize cumulative interest, years to pay off, mortgage insurance, etc.).

This was otherwise a small side project I wanted to do to better understand the home buying process and all the associated costs. I'm quite happy with the tool and hopefully more functionalies will be added in time!

Link to PyPi package:

Pypi Link

To Do

  • Use Sphinx for documentation building
  • Add an ML component for predicting true property valuation to compare with current market value
  • Add relevant visualization wrappers (ie. property overlay on maps)
  • Add an API for pulling listed property information from the web
  • More exception handling

Done

  • Add a demo
  • Configure continuous integration testing --> Github action .yml configured
  • Test suite provides >95% coverage
  • Passing build stamp
  • Publish package (i.e., upload the package to PyPi) and add the link to the README file.

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

mortgage-filter-lukavuko-0.2.4.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

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

mortgage_filter_lukavuko-0.2.4-py3-none-any.whl (13.3 kB view details)

Uploaded Python 3

File details

Details for the file mortgage-filter-lukavuko-0.2.4.tar.gz.

File metadata

  • Download URL: mortgage-filter-lukavuko-0.2.4.tar.gz
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.7.2 pkginfo/1.6.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.3

File hashes

Hashes for mortgage-filter-lukavuko-0.2.4.tar.gz
Algorithm Hash digest
SHA256 9c2f5751731e7f7e3aca03a86b378d720ecb2f563155b1cf4932aecc0046746c
MD5 7c48db623020371f10673bcc2b586395
BLAKE2b-256 0781bd323fad52a46c69f42f49944ffed4dd8e9b895ad4f61e1bc4459059802c

See more details on using hashes here.

File details

Details for the file mortgage_filter_lukavuko-0.2.4-py3-none-any.whl.

File metadata

  • Download URL: mortgage_filter_lukavuko-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 13.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.7.2 pkginfo/1.6.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.3

File hashes

Hashes for mortgage_filter_lukavuko-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 0d2e369e0cd29b12df2d9ee19756cb0fe6462e5a6ec06f8713909166f4e4d189
MD5 0381d5c44b70718125cf964e4f80f7c2
BLAKE2b-256 90ec675488858fb3acd82835b2245dff457ec38e04060396d0f5bb0719c1495e

See more details on using hashes here.

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