Spreadsheet to C++ Library

Convert spreadsheets (XLSM, CSV) into CMake-ready C++ library projects with mathematical expression support. Published on PyPI.

✨ Features

• Multi-format Support: Convert XLSM and CSV files to C++ libraries
• CMake Integration: Generates complete CMake projects ready to build
• Mathematical Expressions: Optional support for formula calculations using C++ Mathematical Expression Toolkit
• Header-only Option: Generate header-only libraries for easy integration
• Flexible Output: Choose between source/header pairs or header-only libraries
• Formula Preservation: Maintain spreadsheet formulas as executable C++ code
• Type Safety: Configurable type handling for strings and numeric values

🚀 Quick Start

Installation

Install from PyPI (recommended):

pip install spreadsheet-to-cpplib

Install from source:

pip install git+https://github.com/shajeen/spreadsheet-to-cpplib.git

Basic Usage

# Convert an Excel file
spreadsheet-to-cpplib --file="your_spreadsheet.xlsm"

# Convert a CSV file
spreadsheet-to-cpplib --file="your_data.csv"

The tool will prompt you with configuration questions and generate the C++ library in an output/ directory.

📋 Configuration Options

When you run the tool, it will ask you several questions to customize the output:

Question	Description	Options
Mathematical Expression Support	Include C++ Mathematical Expression Toolkit for formula calculations	yes / no
Header-only Library	Generate as header-only library (easier integration)	yes / no
Formula as String	Keep formulas as strings in the generated code	yes / no
String to Zero Conversion	Convert string values to 0.0 in numeric contexts	yes / no

📁 Project Structure

your-project/
├── src/
│   └── spreadsheet_to_cpplib/     # Main source code
├── docs/                          # Documentation
├── tests/                         # Test files
├── example/                       # Usage examples
│   ├── csv_example/
│   └── xlsm_example/
├── pyproject.toml                 # Modern Python packaging
├── setup.py                       # Legacy setup (for compatibility)
├── README.md                      # This file
├── LICENSE                        # GPL-3.0 license
├── CONTRIBUTING.md                # Contribution guidelines
└── CODE_OF_CONDUCT.md            # Community guidelines

📖 Examples

Excel (XLSM) Example

spreadsheet-to-cpplib --file="financial_model.xlsm"

This will create a C++ library with:

• Generated header and source files
• CMake configuration
• Mathematical expression support (if enabled)
• Preserved formulas as C++ functions

CSV Example

spreadsheet-to-cpplib --file="data_table.csv"

Output includes:

• Structured C++ classes representing your data
• Accessor methods for each column
• Type-safe data handling

🔧 Development

Prerequisites

• Python 3.8 or higher
• pip or poetry for dependency management

Setting up Development Environment

# Clone the repository
git clone https://github.com/shajeen/spreadsheet-to-cpplib.git
cd spreadsheet-to-cpplib

# Install in development mode
pip install -e ".[dev]"

# Run tests
pytest

# Format code
black src/

# Type checking
mypy src/

Running Tests

# Run all tests
pytest

# Run with coverage
pytest --cov=src/spreadsheet_to_cpplib

🤝 Contributing

We welcome contributions! Please see our Contributing Guidelines for details.

Quick Contribution Steps

1. Open an Issue: Describe your proposed changes or bug report
2. Fork & Clone: Fork the repository and clone your fork
3. Create Branch: Create a feature branch for your changes
4. Make Changes: Implement your changes with tests
5. Test: Ensure all tests pass and add new tests as needed
6. Submit PR: Create a pull request with a clear description

Please read our Code of Conduct before contributing.

📚 Documentation

• User Guide: Detailed usage instructions
• API Documentation: Developer reference
• Examples: Sample projects and use cases
• Wiki: Additional documentation and tutorials

🐛 Bug Reports & Feature Requests

• Report a Bug
• Request a Feature
• View Open Issues

📄 License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

👥 Authors & Contributors

• Sheik S Shajeen Ahamed - Creator & Maintainer - @shajeenahamed

See the list of contributors who participated in this project.

🙏 Acknowledgments

• C++ Mathematical Expression Toolkit for formula evaluation support
• OpenPyXL for Excel file processing
• Pandas for data manipulation

🔗 Links

• Project Homepage: https://github.com/shajeen/spreadsheet-to-cpplib
• PyPI Package: https://pypi.org/project/spreadsheet-to-cpplib/
• Documentation: Wiki

---

⭐ If this project helped you, please consider giving it a star on GitHub!