Metadata-Version: 2.1
Name: footballtestdata
Version: 1.3
Summary: A package to generate fake footballer data
Home-page: https://mazarzycki.com/
Author: Marek Zarzycki
Author-email: contact@mazarzycki.com
Keywords: python,football,soccer,data
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
License-File: LICENSE

# Football Test Data

[![PyPI Version](https://img.shields.io/pypi/v/fake-footballer.svg)](https://pypi.org/project/footballtestdata/)
[![License](https://img.shields.io/pypi/l/fake-footballer.svg)](https://github.com/mazarzycki/footballtestdata/blob/main/LICENSE)

Generate fake footballer data with this Python package.

## Installation
You can install the package using pip:

```
pip install footballtestdata
```
## Usage
Import the FootballerGenerator class and other necessary modules to generate fake footballer data:

```
from footballtestdata import FootballerGenerator, position
from footballtestdata.data import ENG, ITA, SPA, GER
```

Initialize the FootballerGenerator object with the desired data for a specific country:

```
country = 'ENG'
footballer_generator = FootballerGenerator(ENG[0], ENG[1], ENG[2], ENG[3], position)
```
Generate fake footballer data:

```
num_footballers = 10
fake_footballers = [footballer_generator.generate_fake_footballer(country) for _ in range(num_footballers)]
```
Create a pandas DataFrame from the generated data:

```
import pandas as pd
df = pd.DataFrame(fake_footballers)
```
Save the DataFrame to an Excel file:

```
filename = f'fake_{country}_footballers.xlsx'
df.to_excel(filename, index=False)
```
For more usage examples and customization options, please refer to the documentation.

## Documentation
For detailed documentation, refer to the official documentation.

## Contributing
Contributions are welcome! If you would like to contribute to the project, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make the necessary changes and commit them.
4. Open a pull request on the main branch.
5. Please review the contribution guidelines for more details.

## License
This project is licensed under the MIT License.
