Metadata-Version: 2.4
Name: rxiv-maker
Version: 1.5.18
Summary: Automated LaTeX article generation with modern CLI and figure creation capabilities
Author-email: Rxiv-Maker Contributors <rxiv.maker@gmail.com>
License-File: LICENSE
Keywords: automation,cli,command-line,hatch,latex,markdown,publishing,scientific-writing
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Text Processing :: Markup :: LaTeX
Classifier: Topic :: Text Processing :: Markup :: Markdown
Requires-Python: >=3.11
Requires-Dist: click>=8.0.0
Requires-Dist: crossref-commons>=0.0.7
Requires-Dist: matplotlib>=3.7.0
Requires-Dist: numpy>=1.24.0
Requires-Dist: packaging>=21.0.0
Requires-Dist: pandas>=2.0.0
Requires-Dist: pillow>=9.0.0
Requires-Dist: platformdirs>=4.0.0
Requires-Dist: playwright>=1.54.0
Requires-Dist: psutil>=5.9.0
Requires-Dist: pypdf>=6.0.0
Requires-Dist: python-dotenv>=1.0.0
Requires-Dist: pyyaml>=6.0.0
Requires-Dist: requests>=2.28.0
Requires-Dist: rich-click>=1.6.0
Requires-Dist: rich>=13.0.0
Requires-Dist: seaborn>=0.12.0
Requires-Dist: tomli-w>=1.0.0
Requires-Dist: typing-extensions>=4.0.0
Provides-Extra: dev
Requires-Dist: build>=1.2.2.post1; extra == 'dev'
Requires-Dist: coverage[toml]>=7.0; extra == 'dev'
Requires-Dist: hatch>=1.14.1; extra == 'dev'
Requires-Dist: mypy>=1.0; extra == 'dev'
Requires-Dist: nbstripout>=0.7.1; extra == 'dev'
Requires-Dist: nox>=2023.0.0; extra == 'dev'
Requires-Dist: pre-commit>=4.2.0; extra == 'dev'
Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
Requires-Dist: pytest-benchmark>=4.0.0; extra == 'dev'
Requires-Dist: pytest-clarity>=1.0.0; extra == 'dev'
Requires-Dist: pytest-cov>=4.0; extra == 'dev'
Requires-Dist: pytest-datadir>=1.4.0; extra == 'dev'
Requires-Dist: pytest-env>=1.0.0; extra == 'dev'
Requires-Dist: pytest-mock>=3.10.0; extra == 'dev'
Requires-Dist: pytest-notebook>=0.10.0; extra == 'dev'
Requires-Dist: pytest-snapshot>=0.9.0; extra == 'dev'
Requires-Dist: pytest-sugar>=0.9.7; extra == 'dev'
Requires-Dist: pytest-timeout>=2.0.0; extra == 'dev'
Requires-Dist: pytest-xdist>=3.8.0; extra == 'dev'
Requires-Dist: pytest<9.0,>=7.4; extra == 'dev'
Requires-Dist: ruff>=0.12.2; extra == 'dev'
Requires-Dist: twine>=6.1.0; extra == 'dev'
Requires-Dist: types-pyyaml>=6.0.0; extra == 'dev'
Requires-Dist: types-requests>=2.32.4.20250611; extra == 'dev'
Description-Content-Type: text/markdown

[![DOI](https://img.shields.io/badge/DOI-10.48550%2FarXiv.2508.00836-blue)](https://doi.org/10.48550/arXiv.2508.00836)
[![License](https://img.shields.io/github/license/henriqueslab/rxiv-maker?color=Green)](https://github.com/henriqueslab/rxiv-maker/blob/main/LICENSE)
[![GitHub stars](https://img.shields.io/github/stars/henriqueslab/rxiv-maker?style=social)](https://github.com/HenriquesLab/rxiv-maker/stargazers)

# Rxiv-Maker

<img src="src/logo/logo-rxiv-maker.svg" align="right" width="200" style="margin-left: 20px;"/>

Rxiv-Maker transforms scientific writing by converting Markdown manuscripts into publication-ready PDFs with automated figure generation, professional LaTeX typesetting, and zero LaTeX expertise required.

**Key Features:** Scientific cross-references, automated Python/R figures, citation management, Docker support, and modern CLI with rich output.

## 🚀 Getting Started

### Quick Install
```bash
pip install rxiv-maker
rxiv init my-paper
cd my-paper
rxiv pdf
```

### Alternative Methods

**🐳 Docker** (No local dependencies)
```bash
git clone https://github.com/henriqueslab/rxiv-maker.git
cd rxiv-maker
rxiv pdf --engine docker
```

**🌐 Google Colab** (Browser-based)  
[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/HenriquesLab/rxiv-maker/blob/main/notebooks/rxiv_maker_colab.ipynb)

## Essential Commands

```bash
rxiv pdf                            # Generate PDF
rxiv validate                       # Check manuscript
rxiv clean                          # Clean output files
rxiv arxiv                          # Prepare arXiv submission
```

## Documentation

📚 **[Progressive Learning Path](docs/quick-start/)** - 5min → 15min → Daily workflows

📖 **[CLI Reference](docs/reference/cli-commands.md)** - Complete command documentation  

🔧 **[Troubleshooting](docs/troubleshooting/common-issues.md)** - Common issues and solutions

## Contributing

```bash
git clone https://github.com/henriqueslab/rxiv-maker.git
pip install -e ".[dev]" && pre-commit install
```

See [CONTRIBUTING.md](CONTRIBUTING.md) for details.

## Citation

If you use Rxiv-Maker in your research, please cite:

```bibtex
@misc{saraiva_2025_rxivmaker,
      title={Rxiv-Maker: an automated template engine for streamlined scientific publications}, 
      author={Bruno M. Saraiva and Guillaume Jaquemet and Ricardo Henriques},
      year={2025},
      eprint={2508.00836},
      archivePrefix={arXiv},
      url={https://arxiv.org/abs/2508.00836}, 
}
```

## License

MIT License - see [LICENSE](LICENSE) for details.

---

**© 2025 Jacquemet and Henriques Labs | Rxiv-Maker**  
*"Because science is hard enough without fighting with LaTeX."*
