# `forgts`

`forgts` is a Python package that extracts cell formatting from Excel files and applies it to `great_tables` objects, allowing for detailed and consistent data representation.

## Features

- Extracts formatting from Excel spreadsheets.
- Translates Excel formatting attributes to `great_tables` compatible formats.
- Applies styling including font styles, colors, and borders to `great_tables` objects.

## Installation

To install `forgts`, use:

```bash
pip install forgts
```

This package requires Python 3.11 and has dependencies on `pandas`, `openpyxl`, and `great_tables`.

## Usage

Here's a basic example to get you started:

```python
from forgts import format_gt_from_excel

# Format a Great Table from an Excel file
gt_object = format_gt_from_excel('./example/example.xlsx')

# Output the formatted GT object
print(gt_object)
```

## Directory Structure

```
├── .gitignore                  # Customized .gitignore for Python projects
├── LICENSE                     # Project's license
├── pyproject.toml              # Project dependencies
├── README.md                   # Project README
├── docs                        # Quarto's rendered documents
├── _quarto.yml                 # Quarto's config file
├── custom.scss                 # Quarto's Sass stylesheet
├── index.qmd                   # Quarto's home page
└── example                     # Example files and notebooks
    ├── example.ipynb           # Jupyter Notebook demonstrating usage
    ├── example.png             # Example images
    └── example.xlsx            # Example Excel file for demonstrations
```

## Contributing

Contributions are welcome! Please follow these steps:

1. Fork this repository.
2. Create a new branch: `git checkout -b feature-branch-name`.
3. Make your changes and commit them: `git commit -m 'Add some feature'`.
4. Push to the branch: `git push origin feature-branch-name`.
5. Submit a pull request.

## License

This project is licensed under the [MIT LICENSE](LICENSE).

## Acknowledgments

This repository was generated with [cookiecutter](https://github.com/cookiecutter/cookiecutter).

## Authors

Created by: Fernanda Aguirre Ruiz
