Skip to main content

Adds fake credit score data generation to Faker Python package.

Project description

Latest version released on PyPi Build status of the develop branch on Mac/Linux Test coverage BSD 3-Clause License Codacy code quality grade 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 most common non-industry specific credit scoring models are supported:

  • FICO Score 8

  • VantageScore 3.0

  • FICO Score 10

  • FICO Score 10 T

  • Equifax Beacon 5.0

  • Experian/Fair Isaac Risk Model V2SM

  • TransUnion FICO Risk Score, Classic 04

Installation

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

Usage

From the Command Line

$ faker credit_score -i faker_credit_score
756

From within your Python Project

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

By all means, contribute! I’d be happy to work with any first-time open source contributors so please, don’t be shy.

Testing

Execute unit tests and calculate code coverage like so:

$ coverage run -m unittest tests/*
..............
----------------------------------------------------------------------
Ran 14 tests in 0.406s

OK

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

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

faker_credit_score-0.3.0.tar.gz (5.3 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page