Skip to content

Latest commit

 

History

History
95 lines (64 loc) · 2.61 KB

README.rst

File metadata and controls

95 lines (64 loc) · 2.61 KB

faker_credit_score

Latest version released on PyPi Build status of the develop branch on Mac/Linux Test coverage BSD 3-Clause License Black code formatter

faker_credit_score is a community-created provider for the Faker test data generator Python package.

This package provides fake credit score data for testing purposes. The four most common non-industry specific credit scoring models are supported:

  • FICO Score 8
  • Equifax Beacon 5.0
  • Experian/Fair Isaac Risk Model V2SM
  • TransUnion FICO Risk Score, Classic 04

Usage

Install with pip:

$ pip install faker_credit_score

Alternatively, install with setup.py:

$ git clone https://github.com/crd/faker_credit_score.git
$ cd faker_credit_score && python setup.py install

Add the CreditScore Provider to your Faker instance:

from faker import Faker
from faker_credit_score import CreditScore

fake = Faker()
fake.add_provider(CreditScore)

fake.credit_score_name()
'TransUnion FICO Risk Score, Classic 04'
fake.credit_score_provider()
'TransUnion'
fake.credit_score()
791

Contributing

Please, by all means, contribute!

testing

Execute unit tests and calculate code coverage like so:

$ coverage run -m unittest tests/*
........
----------------------------------------------------------------------
Ran 8 tests in 0.224s

OK

$ coverage report
Name                             Stmts   Miss  Cover
----------------------------------------------------
faker_credit_score/__init__.py      40      0   100%