Skip to main content

Console app and Python API for automated preparation of your LaTeX paper for submission in PLOS journals

Project description

About

Console app and Python API for automated preparation of your LaTeX paper for submission in PLOS journals.

Major features

Multiple LaTeX files workflow

If your paper is organized into multiple .tex files, latex2plos will combine them into a single, cohesive .tex file.

\verbatiminput

Transforms a \verbatiminput file inclusion into its equivalent \begin{verbatim}...\end{verbatim} call.

\bibliography

Transforms a \bibliography file inclusion into its equivalent \begin{thebibliography}...\end{thebibliography} call.

This is done as PLOS does not allow submission of BiBTeX databases, and instead requires the reference information to be embedded in the paper directly, as per PLOS LaTeX guidelines.

\lstinputlisting

Copies over the files referenced by \lstinputlisting into the papers export directory.

\includegraphics

Copies over the figures referenced by \includegraphics into the papers export directory. It will also transform all figures into the TIFF image format (LZW compression, at 300 dpi) and remove/comment-out them from the papers exported PDF, as per PLOS LaTeX guidelines and figures guidelines.

Examples

An example paper, based on the PLOS LaTeX template, has been provided in the example directory to verify the latex2plos features listed above. To try it out yourself, just clone the projects repository and run:

$ pip install -e .[dev]
$ cd example
$ make clean export

Afterwards you can compare the contents of the example and example/export directories.

Installation

To install latex2plos run:

$ pip install latex2plos

Console app usage

Quick start:

$ latex2plos <filename>

Show help:

$ latex2plos --help

Python API usage

Quick start:

>>> import logging
>>> logging.basicConfig(level=logging.DEBUG, format="[%(levelname)s] %(message)s")

>>> import os
>>> os.chdir('example')

>>> from latex2plos.main import latex2plos
>>> latex2plos('paper.tex')

Contribute

If you find any bugs, or wish to propose new features please let us know.

If you’d like to contribute, simply fork the repository, commit your changes and send a pull request. Make sure you add yourself to AUTHORS.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

latex2plos-1.0.0.tar.gz (7.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

latex2plos-1.0.0-py2-none-any.whl (9.1 kB view details)

Uploaded Python 2

File details

Details for the file latex2plos-1.0.0.tar.gz.

File metadata

  • Download URL: latex2plos-1.0.0.tar.gz
  • Upload date:
  • Size: 7.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/2.7

File hashes

Hashes for latex2plos-1.0.0.tar.gz
Algorithm Hash digest
SHA256 142bd98b0a9a040a2a3a1a798b86ceb2c060ea2d35d40edd5ae35858dba48101
MD5 2392998133fd83e391b30de7181a9fc2
BLAKE2b-256 0c3d99046a5d461e861785e6ea59262cfdda78164fb1dfa2e76ae0c4ba1b10c5

See more details on using hashes here.

File details

Details for the file latex2plos-1.0.0-py2-none-any.whl.

File metadata

  • Download URL: latex2plos-1.0.0-py2-none-any.whl
  • Upload date:
  • Size: 9.1 kB
  • Tags: Python 2
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/2.7

File hashes

Hashes for latex2plos-1.0.0-py2-none-any.whl
Algorithm Hash digest
SHA256 3097470b15e9f2deef05165e55383163f69272036df2848e2cbb1daa84399e4f
MD5 d4a9a5ea02c247303927b06117478e7f
BLAKE2b-256 2c112954f482eedfa72e46140c4c439d2711b9ddd7f40c8142fcd82b345ddd8a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page