Metadata-Version: 2.4
Name: faker-credit-score
Version: 0.5.2
Summary: Adds fake credit score data generation to Faker Python package.
Project-URL: Homepage, https://github.com/crd/faker-credit-score
Project-URL: Repository, https://github.com/crd/faker-credit-score
Author: Cory Donnelly
License: BSD 3-Clause License
        
        Copyright (c) 2018, Cory Donnelly
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        * Redistributions of source code must retain the above copyright notice, this
          list of conditions and the following disclaimer.
        
        * Redistributions in binary form must reproduce the above copyright notice,
          this list of conditions and the following disclaimer in the documentation
          and/or other materials provided with the distribution.
        
        * Neither the name of the copyright holder nor the names of its
          contributors may be used to endorse or promote products derived from
          this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License-File: LICENSE
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Testing
Requires-Python: >=3.9
Requires-Dist: faker>=37.8.0
Description-Content-Type: text/x-rst

faker_credit_score
==================

|pypi| |status| |coverage| |license| |black|

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
* FICO Score 9
* FICO Score 10
* FICO Score 10 T
* VantageScore 3.0
* VantageScore 4.0
* UltraFICO
* Equifax Beacon 5.0
* Experian/Fair Isaac Risk Model V2SM
* TransUnion FICO Risk Score, Classic 04

Installation
------------

Install with pip (this will also install `Faker`_ if you don't already have it):

.. code:: bash

    $ pip install faker-credit-score

Usage
-----

From the Command Line
~~~~~~~~~~~~~~~~~~~~~

.. code:: bash

    $ faker credit_score -i faker_credit_score
    756

From within your Python Project
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Add the ``CreditScore`` Provider to your ``Faker`` instance:

.. code:: python

    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:

.. code:: bash

    $ pytest --cov=faker_credit_score
    ..............
    ----------------------------------------------------------------------
    Ran 14 tests in 0.406s

    OK

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

.. |pypi| image:: https://img.shields.io/pypi/v/faker-credit-score.svg?style=flat-square
   :target: https://pypi.org/project/faker-credit-score/
   :alt: Latest version released on PyPI

.. |status| image:: https://github.com/crd/faker_credit_score/actions/workflows/release.yml/badge.svg?style=flat-square
   :target: https://github.com/crd/faker_credit_score/actions/workflows/release.yml
   :alt: Release workflow status

.. |coverage| image:: https://coveralls.io/repos/github/crd/faker_credit_score/badge.svg?branch=develop&style=flat-square
    :target: https://coveralls.io/github/crd/faker_credit_score?branch=develop
    :alt: Test coverage

.. |license| image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg?style=flat-square
    :target: https://github.com/crd/faker_credit_score/blob/master/LICENSE
    :alt: BSD 3-Clause License

.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square
    :target: https://github.com/ambv/black
    :alt: Black code formatter

.. _Faker: https://github.com/joke2k/faker
