Metadata-Version: 2.1
Name: labpaper
Version: 1.0.2
Summary: A Jupyter notebook exporter for academic papers using Tufte style
Author-email: Khris Griffis <khris.griffis.phd@gmail.com>
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Framework :: Jupyter
Classifier: Framework :: Jupyter :: JupyterLab
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: nbconvert>=7.0.0
Requires-Dist: traitlets>=5.0.0
Requires-Dist: jupyter_core>=4.0.0
Requires-Dist: jinja2>=3.0.0
Requires-Dist: nbformat>=5.0.0
Requires-Dist: nameparser>=1.1.0
Requires-Dist: usaddress>=0.5.10
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0; extra == "dev"
Requires-Dist: black>=22.0; extra == "dev"
Requires-Dist: isort>=5.0; extra == "dev"
Requires-Dist: flake8>=4.0; extra == "dev"
Requires-Dist: build>=0.7.0; extra == "dev"
Requires-Dist: twine>=4.0.0; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx>=4.0; extra == "docs"
Requires-Dist: sphinx-rtd-theme>=1.0; extra == "docs"
Requires-Dist: myst-parser>=0.18; extra == "docs"

# LabPaper

A sophisticated Jupyter notebook exporter designed for creating academic papers in Tufte style. This package provides a seamless integration between Jupyter notebooks and professional academic paper formats.

## Features

- Export Jupyter notebooks to professional academic paper formats
- Tufte-style design principles
- Support for Nature journal format
- Customizable templates and exporters
- Advanced preprocessing capabilities
- Flexible filtering system

## Installation

```bash
pip install labpaper
```

## Quick Start

Basic usage example:

```python
jupyter nbconvert --to nature your_notebook.ipynb
```

## Documentation

- [Exporters](docs/exporters.md) - Document conversion and output generation
- [Filters](docs/filters.md) - Content transformation and processing
- [Preprocessors](docs/preprocessors.md) - Pre-conversion notebook manipulation
- [Templates](docs/templates.md) - Document layout and styling
- [TeX Configuration](docs/texmf.md) - TeX/LaTeX setup and configuration

## Requirements

- Python ≥ 3.11
- Jupyter ≥ 7.0.0
- nbconvert ≥ 7.16.0
- pandoc >= 3.6
- A LaTeX distribution (e.g., TeX Live, MiKTeX)
- Other dependencies are handled automatically during installation

## Development

1. Clone the repository
2. Create a virtual environment
3. Install in development mode:
   ```bash
   pip install -e ".[dev]"
   ```

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## License

This project is licensed under the BSD License - see the [LICENSE](LICENSE) file for details.
