Metadata-Version: 2.4
Name: rxiv-maker
Version: 1.20.4
Summary: Write scientific preprints in Markdown. Generate publication-ready PDFs efficiently.
Project-URL: Homepage, https://github.com/HenriquesLab/rxiv-maker
Project-URL: Documentation, https://github.com/HenriquesLab/rxiv-maker#readme
Project-URL: Repository, https://github.com/HenriquesLab/rxiv-maker
Project-URL: Issues, https://github.com/HenriquesLab/rxiv-maker/issues
Project-URL: Changelog, https://github.com/HenriquesLab/rxiv-maker/blob/main/CHANGELOG.md
Project-URL: Bug Reports, https://github.com/HenriquesLab/rxiv-maker/issues
Project-URL: Source Code, https://github.com/HenriquesLab/rxiv-maker
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.10
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.10
Requires-Dist: click>=8.0.0
Requires-Dist: crossref-commons>=0.0.7
Requires-Dist: gitpython>=3.1.0
Requires-Dist: henriqueslab-updater>=1.2.0
Requires-Dist: latex2mathml>=3.78.0
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: pdf2image>=1.16.0
Requires-Dist: pillow>=9.0.0
Requires-Dist: platformdirs>=4.0.0
Requires-Dist: playwright>=1.54.0
Requires-Dist: prompt-toolkit>=3.0.0
Requires-Dist: pypdf>=6.0.0
Requires-Dist: python-docx>=1.1.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: pypdf2>=3.0.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<10.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="https://raw.githubusercontent.com/HenriquesLab/rxiv-maker/main/src/logo/logo-rxiv-maker.svg" align="right" width="200" style="margin-left: 20px;"/>

Rxiv-Maker converts enhanced Markdown into professional PDFs with automated figure generation, citation management, and LaTeX typesetting. Write in Markdown, get publication-ready output for arXiv, bioRxiv, and other preprint servers.

## Installation

**macOS** (includes LaTeX automatically):
```bash
brew install henriqueslab/formulas/rxiv-maker
```

**Linux / Windows (WSL)**:
```bash
pipx install rxiv-maker    # or: uv tool install rxiv-maker
```

Verify setup:
```bash
rxiv check-installation
```

LaTeX is required. See the [installation guide](https://rxiv-maker.henriqueslab.org/getting-started/installation/) for platform-specific LaTeX instructions.

## Quick Start

```bash
rxiv init my-paper
cd my-paper
rxiv pdf
```

To explore a complete working example:
```bash
rxiv get-rxiv-preprint
cd manuscript-rxiv-maker/MANUSCRIPT
rxiv pdf
```

## Features

- **Enhanced Markdown** - Scientific cross-references (`@fig:plot`, `@eq:formula`), auto-numbered figures/tables/equations, LaTeX math
- **Automated figures** - Python and R scripts executed during PDF generation, with intelligent caching
- **Executable code blocks** - Jupyter-like `{{py:exec}}` and `{{py:get variable}}` for live data in manuscripts
- **Citation management** - BibTeX with `[@citation]` syntax, multiple styles, inline DOI resolution
- **Dual output** - PDF and DOCX from the same source
- **arXiv/bioRxiv submission** - Generate submission packages automatically
- **Track changes** - Visual diff between manuscript versions
- **VS Code extension** - Syntax highlighting, citation autocompletion, one-click builds

## Documentation

**[rxiv-maker.henriqueslab.org](https://rxiv-maker.henriqueslab.org)** - Installation, guides, CLI reference, troubleshooting.

For contributors: **[CONTRIBUTING.md](CONTRIBUTING.md)**

## Ecosystem

| Repository | Purpose |
|------------|---------|
| [rxiv-maker](https://github.com/HenriquesLab/rxiv-maker) | Core CLI tool |
| [docker-rxiv-maker](https://github.com/HenriquesLab/docker-rxiv-maker) | Pre-configured container with LaTeX |
| [manuscript-rxiv-maker](https://github.com/HenriquesLab/manuscript-rxiv-maker) | Complete example (arXiv:2508.00836) |
| [vscode-rxiv-maker](https://marketplace.visualstudio.com/items?itemName=HenriquesLab.rxiv-maker) | VS Code extension |

## Publications

| Publication | Venue |
|-------------|-------|
| [Rxiv-Maker: an automated template engine for streamlined scientific publications](https://arxiv.org/abs/2508.00836) | arXiv (2025) |
| [Customizable FDM-based zebrafish embryo mold for live imaging](https://doi.org/10.1101/2025.11.24.689779) | bioRxiv (2025) |
| [mAIcrobe: an open-source framework for high-throughput bacterial image analysis](https://doi.org/10.1101/2025.10.21.683709) | bioRxiv (2025) |
| [Filopodome proteomics identifies CCT8 as a MYO10 interactor critical for filopodia functions](https://doi.org/10.64898/2025.12.03.691809) | bioRxiv (2025) |
| [EZInput: A Cross-Environment Python Library for Easy UI Generation in Scientific Computing](https://arxiv.org/abs/2601.08859) | arXiv (2026) |
| [Packaging Jupyter notebooks as installable desktop apps using LabConstrictor](https://arxiv.org/abs/2603.10704) | arXiv (2026) |

Using Rxiv-Maker for your research? [Let us know](https://github.com/HenriquesLab/rxiv-maker/issues/new?template=publication_submission.yml).

## Community

- [GitHub Discussions](https://github.com/henriqueslab/rxiv-maker/discussions) - Questions and tips
- [Issues](https://github.com/henriqueslab/rxiv-maker/issues) - Bug reports and feature requests
- [Google Colab](https://colab.research.google.com/github/HenriquesLab/rxiv-maker/blob/main/notebooks/rxiv_maker_colab.ipynb) - Try without installing

## Citation

```bibtex
@misc{saraiva_2025_rxivmaker,
  title={Rxiv-Maker: an automated template engine for streamlined scientific publications},
  author={Bruno M. Saraiva and Ant\'{o}nio D. Brito 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.
