Metadata-Version: 2.1
Name: faker-marketdata
Version: 0.3
Summary: Sample market data for Faker
Home-page: https://github.com/rubenafo/faker_marketdata
Author: Ruben Afonso
Author-email: rbfrancos@gmail.com
Keywords: faker,testdata,financedata,python,marketdata,isin,sedol,cusip,ticker,figi
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# faker_marketdata
Generates random, valid market data for testing purposes.

## Installation

``` bash
pip install faker_marketdata
```

## Usage

Add as a provider to your Faker instance:
``` python
>>> from faker import Faker
>>> from faker_marketdata import MarketDataProvider
>>> fake = Faker()
>>> fake.add_provider(MarketDataProvider())
```
Optionally you can use a seed value to have repeatable output: 
``` python
>> fake.add_provider(MarketDataProvider(see=1220))
```

Now you can start to generate market data, some examples:
``` python
>> fake.isin()   # "GTYMQXUIYPB6"
>> fake.sedol()  # "NKDEKC8"
>> fake.cusip()  # "Z57XGDJW7"
>> fake.ticker() # "GRTT"
```

## Documentation
Supported market data identifiers:
* ISIN
* SEDOL
* MIC
* LEI
* CUSIP
* RIC
* TICKER
* NSIN
* FIGI
* Market type (e.g. "bond", "commodity", "otc")
