latexreport 0.1.0__tar.gz

latexreport-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,65 @@
+# Contributing to latexreport
+
+Thanks for your interest in contributing! Here's how to get started.
+
+## Setup
+
+```bash
+git clone https://github.com/aquila1004/latexreport
+cd latexreport
+python -m venv venv
+source venv/bin/activate  # or venv\Scripts\activate on Windows
+pip install -e ".[dev]"
+```
+
+## Development
+
+### Run Tests
+
+```bash
+pytest                              # Run all tests
+pytest --cov=src/latexreport       # With coverage
+pytest -v                           # Verbose output
+```
+
+### Code Quality
+
+```bash
+black src tests examples             # Format code
+ruff check --fix src tests examples  # Linting
+mypy src/latexreport               # Type checking
+```
+
+### Before Committing
+
+```bash
+# Format + lint + test
+black src tests examples
+ruff check --fix src tests examples
+pytest
+```
+
+## Ideas for Contribution
+
+- 📝 Add more themes
+- 🎨 Better color customization
+- 📊 Built-in chart/plot support
+- 📚 Bibliography support (bibtex)
+- 🌍 Multi-language support
+- 📖 More comprehensive documentation
+- 🧪 Better test coverage
+- ⚡ Performance improvements
+
+## Pull Request Process
+
+1. Fork the repository
+2. Create a feature branch: `git checkout -b feature/your-feature`
+3. Make your changes
+4. Test: `pytest`
+5. Commit: `git commit -m "Add feature: your feature"`
+6. Push: `git push origin feature/your-feature`
+7. Open a Pull Request
+
+## Questions?
+
+Open an issue on the repository!

latexreport-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Áquila Oliveira Souza
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

latexreport-0.1.0/MANIFEST.in

@@ -0,0 +1,6 @@
+include README.md
+include LICENSE
+include CONTRIBUTING.md
+recursive-include src *.py
+recursive-include tests *.py
+recursive-include examples *.py

latexreport-0.1.0/PKG-INFO

@@ -0,0 +1,147 @@
+Metadata-Version: 2.4
+Name: latexreport
+Version: 0.1.0
+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}
+}
+```

latexreport-0.1.0/README.md

@@ -0,0 +1,112 @@
+# 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}
+}
+```

latexreport-0.1.0/examples/basic.py

@@ -0,0 +1,45 @@
+"""Basic example: Create a simple report."""
+
+from latexreport import Report, Section, List, ListItem
+
+# Create report
+report = Report(
+    title="My First Report",
+    author="Your Name",
+    subtitle="A simple example using latexreport",
+)
+
+# Add a section
+report.add_section(Section("Introduction"))
+report.add_text("This is a simple report generated with latexreport.")
+report.add_text("You can add text, figures, tables, and more using Python.")
+
+# Add another section
+report.add_section(Section("Features"))
+report.add_text("The library supports:")
+
+# Add a list
+features_list = List([
+    "Creating structured documents",
+    "Adding figures and tables",
+    "Code blocks with syntax highlighting",
+    "Mathematical formulas",
+    "Automatic PDF compilation",
+])
+report.add_list(features_list)
+
+# Add section with formulas
+report.add_section(Section("Math Example"))
+report.add_text("Here's a simple equation:")
+report.add_formula("E = mc^2")
+
+report.add_text("And an inline formula: " + "$\\sqrt{x^2 + y^2}$")
+
+# Export
+print("Generating LaTeX...")
+report.to_latex("output/basic.tex")
+print("✓ LaTeX file: output/basic.tex")
+
+print("\nCompiling to PDF...")
+report.to_pdf("output/basic.pdf")
+print("✓ PDF file: output/basic.pdf")

latexreport-0.1.0/pyproject.toml

@@ -0,0 +1,67 @@
+[build-system]
+requires = ["setuptools>=65.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "latexreport"
+version = "0.1.0"
+description = "Generate professional LaTeX reports and PDFs programmatically with Python"
+readme = "README.md"
+requires-python = ">=3.10"
+license = {text = "MIT"}
+authors = [
+    {name = "Áquila Oliveira Souza", email = "aquilasouza1004@gmail.com"}
+]
+keywords = ["latex", "report", "pdf", "documentation", "automation"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Education",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Office/Business",
+    "Topic :: Text Processing :: Markup :: LaTeX",
+]
+
+dependencies = [
+    "matplotlib>=3.7",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-cov>=4.0",
+    "black>=23.0",
+    "ruff>=0.1.0",
+    "mypy>=1.0",
+]
+pdf = [
+    "latexmk>=1.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/aquila1004/latexreport"
+Repository = "https://github.com/aquila1004/latexreport.git"
+Documentation = "https://github.com/aquila1004/latexreport#readme"
+Issues = "https://github.com/aquila1004/latexreport/issues"
+
+[tool.setuptools]
+packages = ["latexreport"]
+
+[tool.setuptools.package-dir]
+"" = "src"
+
+[tool.black]
+line-length = 100
+target-version = ["py310"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "--cov=src/latexreport --cov-report=term-missing"

latexreport-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

latexreport-0.1.0/src/latexreport/__init__.py

@@ -0,0 +1,44 @@
+"""latexreport — Generate professional LaTeX reports and PDFs with Python.
+
+A simple, Pythonic interface to create LaTeX documents programmatically.
+
+Quick start:
+    >>> from latexreport import Report, Section, Figure
+    >>> report = Report(title="My Report", author="Author Name")
+    >>> report.add_section(Section("Introduction"))
+    >>> report.add_text("Hello world!")
+    >>> report.to_pdf("output.pdf")
+
+Main classes:
+    Report: Main document container
+    Section: Section with title and content
+    Figure: Embedded figure/image
+    Table: Data table
+    Code: Code block
+    Formula: Mathematical equation
+
+For full documentation, see: https://github.com/aquila1004/latexreport
+"""
+
+from .core import Report, Section, Content
+from .elements import Figure, Table, Code, Formula, Text, List, ListItem
+from .themes import Theme, THEMES
+
+__version__ = "0.1.0"
+__author__ = "Áquila Oliveira Souza"
+__license__ = "MIT"
+
+__all__ = [
+    "Report",
+    "Section",
+    "Content",
+    "Figure",
+    "Table",
+    "Code",
+    "Formula",
+    "Text",
+    "List",
+    "ListItem",
+    "Theme",
+    "THEMES",
+]

latexreport-0.1.0/src/latexreport/compiler.py

@@ -0,0 +1,112 @@
+"""LaTeX compilation utilities."""
+
+from __future__ import annotations
+
+import subprocess
+import sys
+from pathlib import Path
+from typing import Optional
+
+
+def compile_to_pdf(
+    tex_file: str | Path,
+    output_pdf: Optional[str | Path] = None,
+    cleanup: bool = True,
+    attempts: int = 2,
+) -> Path:
+    """Compile LaTeX file to PDF.
+
+    Args:
+        tex_file: Path to .tex file
+        output_pdf: Output PDF path (default: same name as .tex, .pdf extension)
+        cleanup: Remove temporary files after compilation
+        attempts: Number of compilation attempts (for bibliography, refs, etc)
+
+    Returns:
+        Path to generated PDF file
+
+    Raises:
+        RuntimeError: If compilation fails
+    """
+    tex_path = Path(tex_file).resolve()
+    if not tex_path.exists():
+        raise FileNotFoundError(f"LaTeX file not found: {tex_path}")
+
+    output_pdf = Path(output_pdf or tex_path.with_suffix(".pdf")).resolve()
+
+    # Check if pdflatex is available
+    try:
+        subprocess.run(
+            ["pdflatex", "--version"],
+            capture_output=True,
+            check=True,
+            timeout=5,
+        )
+    except (subprocess.CalledProcessError, FileNotFoundError):
+        raise RuntimeError(
+            "pdflatex not found. Install LaTeX:\n"
+            "  Ubuntu: sudo apt-get install texlive-latex-base\n"
+            "  macOS: brew install mactex\n"
+            "  Windows: https://miktex.org/download"
+        )
+
+    # Compile
+    output_dir = tex_path.parent
+    for attempt in range(attempts):
+        try:
+            subprocess.run(
+                [
+                    "pdflatex",
+                    "-interaction=nonstopmode",
+                    f"-output-directory={output_dir}",
+                    str(tex_path),
+                ],
+                capture_output=True,
+                check=True,
+                timeout=60,
+            )
+        except subprocess.CalledProcessError as e:
+            if attempt < attempts - 1:
+                continue
+            raise RuntimeError(f"LaTeX compilation failed:\n{e.stderr.decode()}") from e
+
+    # Check output
+    temp_pdf = tex_path.with_suffix(".pdf")
+    if not temp_pdf.exists():
+        raise RuntimeError(f"PDF not generated at {temp_pdf}")
+
+    # Move to final location if different
+    if temp_pdf != output_pdf:
+        temp_pdf.rename(output_pdf)
+
+    # Cleanup temporary files
+    if cleanup:
+        suffixes_to_remove = [".aux", ".log", ".out", ".toc", ".nav", ".snm"]
+        for suffix in suffixes_to_remove:
+            temp_file = tex_path.with_suffix(suffix)
+            if temp_file.exists():
+                temp_file.unlink()
+
+    print(f"✓ PDF generated: {output_pdf}")
+    return output_pdf
+
+
+def find_latex_compiler() -> Optional[str]:
+    """Find available LaTeX compiler (pdflatex, xelatex, lualatex).
+
+    Returns:
+        Name of available compiler or None if not found
+    """
+    for compiler in ["pdflatex", "xelatex", "lualatex"]:
+        try:
+            subprocess.run(
+                [compiler, "--version"],
+                capture_output=True,
+                check=True,
+                timeout=5,
+            )
+            return compiler
+        except (subprocess.CalledProcessError, FileNotFoundError):
+            continue
+
+    return None