faker-credit-score 1.0.0

Why this exists

Hardcoding credit_score = 720 in your fixtures doesn’t test anything. You don’t know if that’s “good” for FICO 8 or “fair” for Equifax Beacon 5.0 and random.randint(300, 850) gives you numbers that don’t map to any real model.

If you’re building a lending flow, an insurance quote engine, or anything that branches on creditworthiness you need scores that come from the right ranges, tied to real bureau names, with accurate tiering.

Before:

# What does 720 even test? Which model? Which tier?
user["credit_score"] = 720

After:

fake.credit_score(tier="poor")           # 542 -- test the denial path
fake.credit_score(tier="exceptional")    # 831 -- test the approval path

result = fake.credit_score_full("fico5")
# CreditScoreResult(name='Equifax Beacon 5.0', provider='Equifax', score=687)

Features

• 10 of the most commonly-used scoring models (FICO 8/9/10, VantageScore 3.0/4.0, and more)

• Tier-based generation: poor, fair, good, very_good, exceptional

• Score classification

• Structured results via CreditScoreResult namedtuple

• Works with the Faker CLI

• 100% test coverage

Installation

pip install faker-credit-score

Two lines to add it to your existing Faker setup:

from faker import Faker
from faker_credit_score import CreditScore

fake = Faker()
fake.add_provider(CreditScore)

Usage

fake.credit_score()
# 791

fake.credit_score("fico5")
# 687

fake.credit_score_name()
# 'TransUnion FICO Risk Score, Classic 04'

fake.credit_score_provider()
# 'TransUnion'

fake.credit_score_full()
# CreditScoreResult(name='FICO Score 8', provider='Equifax', score=791)

name, provider, score = fake.credit_score_full("fico5")

$ faker credit_score -i faker_credit_score
756

$ faker credit_score_full -i faker_credit_score
Equifax Beacon 5.0
Equifax
687

fake.credit_score(tier="poor")
# 542

fake.credit_score(tier="exceptional")
# 831

fake.credit_score_tier()
# 'good'

fake.credit_score_tier(score=720)
# 'good'

Contributing

Contributions are welcome, including from first-time open source contributors. See CONTRIBUTING.md for setup instructions and ideas.

License

BSD 3-Clause. See LICENSE for details.