cfpb / owning-a-home-api Goto Github PK

for the Rate Checker API and Mortgage Insurance there are different values for boolean true/false:

Rate checker io param
accepts the following values:

0 = false,
1 = true,
blank

Mortgage Insurance va_first_use param
accepts

Y = Yes
N = No

I recommend we keep them consistent so use what the Rate Checker currently implements (though honestly I'd prefer true/false for both)

I know that we are using version 2.4.3 and I am wondering when are we updating to the latest version.

http://www.django-rest-framework.org/topics/3.0-announcement/

As a new user of the application, I can install the countylimits and ratechecker apps in a Django project, but there is no sample data or documentation regarding that data's format for the load_daily_data management command.

Despite the fact that we explicitly state that the app relies on data that is not available externally, sample data (or possibly test fixtures) would be useful in setting up copy of the ratechecker app.

The test_standalone.py script executes tests against a sqlite database. However, MySQL is required for two reasons:

MYSQL-python is listed in the requirements.txt, and this won't install without mysql_config installed on the system (e.g. via brew install mysql)

The ratechecker/management/commands/load_daily_data.py management command imports _mysql_exceptions, which causes tests to fail unless the MySQL stack is installed.

http://build.consumerfinance.gov/oah-api/mortgage-insurance/%3Cscript%3Ealert%281%29%3C/script%3E?price=520000&loan_amount=500000&minfico=730&maxfico=750&loan_term=30&rate_structure=fixed&loan_type=fixed&loan_type=conf

Querying the API endpoints for ratechecker and countylimits result in the following errors:

{
    "detail": "Required parameter 'loan_amount' is missing"
}

{
    "detail": "Required parameter state is missing"
}

As a new user of the application, it would be useful for the README to provide an overview of the parameters utilized in the ratechecker and countylimits APIs.

setup.py lists the version number as 1.0. This is the version number that any version specifiers expressed by, say, pip, will pay attention to.

There are git tags for versions 0.9.1 through 0.9.6.

The CHANGELOG.md file lists a 0.0.1 version from 2014-11-07 without any particularly interesting information.

There should probably be some consistency between version numbers.

@fna can you backfill this information from the Releases and then make sure to keep this document up to date?

The mock library is required to run the test_standalone.py script, but mock is not included in the requirements.txt.

The need to install mock should be either mentioned in the README instructions, included in the requirements.txt, or added to something like requirements-test.txt

Is it possible not to expose pages like this?

http://www.consumerfinance.gov/oah-api/rates/rate-checker