Metadata-Version: 2.4
Name: latexreport
Version: 0.1.4
Summary: Generate professional LaTeX reports and PDFs programmatically with Python
Author-email: Áquila Oliveira Souza <aquilasouza1004@gmail.com>
License: MIT
Project-URL: Homepage, https://github.com/aquila1004/latexreport
Project-URL: Repository, https://github.com/aquila1004/latexreport.git
Project-URL: Documentation, https://github.com/aquila1004/latexreport#readme
Project-URL: Issues, https://github.com/aquila1004/latexreport/issues
Keywords: latex,report,pdf,documentation,automation
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Office/Business
Classifier: Topic :: Text Processing :: Markup :: LaTeX
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: matplotlib>=3.7
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0; extra == "dev"
Requires-Dist: black>=23.0; extra == "dev"
Requires-Dist: ruff>=0.1.0; extra == "dev"
Requires-Dist: mypy>=1.0; extra == "dev"
Provides-Extra: pdf
Requires-Dist: latexmk>=1.0; extra == "pdf"
Dynamic: license-file

# latexreport

🚀 Generate professional LaTeX reports and PDFs programmatically with Python.

No LaTeX knowledge required — build beautiful documents with simple Python code.

## Installation

```bash
pip install latexreport
```

To compile PDFs automatically, also install the LaTeX compiler:

```bash
# Ubuntu/Debian
sudo apt-get install texlive-latex-base texlive-latex-extra

# macOS
brew install mactex

# Windows
# Download from https://miktex.org/download
```

## Quick Start

```python
from latexreport import Report, Section, Figure, Table

# Create report
report = Report(
    title="My Report",
    author="Your Name",
    subtitle="A professional document"
)

# Add content
report.add_section(Section("Introduction"))
report.add_text("This is the introduction.")

report.add_figure("chart.png", caption="Chart 1", width=0.8)

report.add_section(Section("Results"))
report.add_table(
    data=[[1, 2, 3], [4, 5, 6]],
    columns=["A", "B", "C"],
    caption="Table 1"
)

# Export
report.to_latex("report.tex")      # Save LaTeX file
report.to_pdf("report.pdf")         # Compile to PDF
```

## Features

✅ **Simple API** — Pythonic interface for LaTeX  
✅ **Sections & Subsections** — Nested structure support  
✅ **Rich Content** — Text, figures, tables, code blocks, equations  
✅ **Customizable** — Themes, colors, fonts, preamble  
✅ **Auto-Compilation** — Generate PDFs with one method call  
✅ **Cross-References** — Labels, captions, references  
✅ **Extensible** — Add custom LaTeX commands  

## Examples

See [examples/](examples/) directory:

- `basic.py` — Simple report with text and figures
- `academic.py` — Thesis-like document
- `presentation.py` — Slides with beamer
- `custom_theme.py` — Custom styling

## Documentation

- [API Reference](docs/api.md) — Complete class and method documentation
- [Themes](docs/themes.md) — Available themes and customization
- [Advanced](docs/advanced.md) — Custom commands, environments, preamble
- [Troubleshooting](docs/faq.md) — Common issues and solutions

## Development

```bash
git clone https://github.com/aquila1004/latexreport
cd latexreport
python -m venv venv
source venv/bin/activate
pip install -e ".[dev]"
pytest
```

## License

MIT License — see [LICENSE](LICENSE)

## Contributing

Contributions welcome! See [CONTRIBUTING.md](CONTRIBUTING.md)

## Citation

If you use latexreport in academic work:

```bibtex
@software{latexreport2024,
  title={latexreport: Python LaTeX Report Generator},
  author={Souza, Áquila},
  year={2024},
  url={https://github.com/aquila1004/latexreport}
}
```
