Metadata-Version: 2.4
Name: ilc-provider
Version: 0.1.2
Summary: Faker provider for ILC data models
Project-URL: Repository, https://github.com/fourtreestech/ilc-provider
Project-URL: Documentation, https://ilc-provider.readthedocs.io/
Author-email: Neil Martin <neil@fourtrees.tech>
License-Expression: MIT
License-File: LICENSE.txt
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries
Classifier: Typing :: Typed
Requires-Python: >=3.12
Requires-Dist: faker>=37.0.2
Requires-Dist: ilc-models>=0.1.1
Description-Content-Type: text/markdown

### ilc-provider

![version](https://img.shields.io/badge/version-0.1.2-blue)
![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Ffourtreestech%2Filc-provider%2Fmain%2Fpyproject.toml)
![coverage](https://img.shields.io/badge/coverage-100%25-green)

**Faker provider for *ILC* data models**

Generates fake data for all data models: players, teams, leagues, etc.

When imported the *ilc_provider* package creates a 
[Faker](https://github.com/joke2k/faker/) instance
and adds itself as a provider. It can then be called
like any other provider:

    from ilc_provider import fake
    league = fake.league()

See the documentation for the full list of data that can be generated.

## Installation

    (.venv) $ pip install ilc-provider

## Usage

*ilc_provider* can be used as a [Pytest](https://docs.pytest.org/) fixture:

    # conftest.py

    import pytest
    from ilc_provider import fake

    # Any element of the provider can be accessed
    # from this fixture:
    # match = ilc_fake.match()
    @pytest.fixture(scope="session")
    def ilc_fake():
        return fake

    # A fake league is intensive to set up, so it is
    # usually best to make a session-scoped league fixture:
    @pytest.fixture(scope="session")
    def fake_league(ilc_fake):
        return ilc_fake.league()

