latex-jinja


Namelatex-jinja JSON
Version 0.3.1 PyPI version JSON
download
home_pageNone
SummaryLatex templating with Jinja and PDF conversion.
upload_time2024-11-29 17:10:17
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
license# MIT License Copyright (c) 2024 Joel Lefkowitz 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.
keywords pdf jinja latex template
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Latex Jinja

Latex templating with Jinja and PDF conversion.

![Review](https://img.shields.io/github/actions/workflow/status/JoelLefkowitz/latex-jinja/review.yaml)
![Version](https://img.shields.io/pypi/v/latex-jinja)
![Downloads](https://img.shields.io/pypi/dw/latex-jinja)
![Quality](https://img.shields.io/codacy/grade/6c16c26db4424b2a92fa96bc09c91dac)
![Coverage](https://img.shields.io/codacy/coverage/6c16c26db4424b2a92fa96bc09c91dac)

## Example

Copy the template files:

```
python -m latex-jinja init
```

```properties
INFO Copied "inputs.json"
INFO Copied "template.tex.j2"
```

This creates a [Jinja](https://jinja.palletsprojects.com) latex template and an inputs file:

`template.tex.j2`

```.j2
\documentclass[12pt]{article}
\begin{document}

\title{ {{title}} }
\maketitle

...

\end{document}
```

`inputs.json`

```json
{
  "author": "Author",
  "title": "Title"
}
```

Run the Jinja templating engine and produce a PDF:

```
python -m latex-jinja build
```

```properties
INFO Loaded inputs from "inputs.json"
INFO Rendered the template "template.tex.j2
INFO Created "article.pdf"
```

This will populate the template and produces a PDF:

![Example](docs/images/example.png)

## Installing

Download the [TeX distribution](https://miktex.org/), this includes `pdflatex` which is used by this package.

```bash
pip install latex-jinja
```

## Documentation

Documentation and more detailed examples are hosted on [Github Pages](https://joellefkowitz.github.io/latex).

## Tooling

### Dependencies

To install dependencies:

```bash
yarn install
pip install .[all]
```

### Tests

To run tests:

```bash
thx test
```

### Documentation

To generate the documentation locally:

```bash
thx docs
```

### Linters

To run linters:

```bash
thx lint
```

### Formatters

To run formatters:

```bash
thx format
```

## Contributing

Please read this repository's [Code of Conduct](CODE_OF_CONDUCT.md) which outlines our collaboration standards and the [Changelog](CHANGELOG.md) for details on breaking changes that have been made.

This repository adheres to semantic versioning standards. For more information on semantic versioning visit [SemVer](https://semver.org).

Bump2version is used to version and tag changes. For example:

```bash
bump2version patch
```

### Contributors

- [Joel Lefkowitz](https://github.com/joellefkowitz) - Initial work

## Remarks

Lots of love to the open source community!

<div align='center'>
    <img width=200 height=200 src='https://media.giphy.com/media/osAcIGTSyeovPq6Xph/giphy.gif' alt='Be kind to your mind' />
    <img width=200 height=200 src='https://media.giphy.com/media/KEAAbQ5clGWJwuJuZB/giphy.gif' alt='Love each other' />
    <img width=200 height=200 src='https://media.giphy.com/media/WRWykrFkxJA6JJuTvc/giphy.gif' alt="It's ok to have a bad day" />
</div>

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "latex-jinja",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "PDF, jinja, latex, template",
    "author": null,
    "author_email": "Joel Lefkowitz <joellefkowitz@hotmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/0e/a7/9510b7abf78b78201430522551d10b4ca37299e28e73f4ce58186e935050/latex_jinja-0.3.1.tar.gz",
    "platform": null,
    "description": "# Latex Jinja\n\nLatex templating with Jinja and PDF conversion.\n\n![Review](https://img.shields.io/github/actions/workflow/status/JoelLefkowitz/latex-jinja/review.yaml)\n![Version](https://img.shields.io/pypi/v/latex-jinja)\n![Downloads](https://img.shields.io/pypi/dw/latex-jinja)\n![Quality](https://img.shields.io/codacy/grade/6c16c26db4424b2a92fa96bc09c91dac)\n![Coverage](https://img.shields.io/codacy/coverage/6c16c26db4424b2a92fa96bc09c91dac)\n\n## Example\n\nCopy the template files:\n\n```\npython -m latex-jinja init\n```\n\n```properties\nINFO Copied \"inputs.json\"\nINFO Copied \"template.tex.j2\"\n```\n\nThis creates a [Jinja](https://jinja.palletsprojects.com) latex template and an inputs file:\n\n`template.tex.j2`\n\n```.j2\n\\documentclass[12pt]{article}\n\\begin{document}\n\n\\title{ {{title}} }\n\\maketitle\n\n...\n\n\\end{document}\n```\n\n`inputs.json`\n\n```json\n{\n  \"author\": \"Author\",\n  \"title\": \"Title\"\n}\n```\n\nRun the Jinja templating engine and produce a PDF:\n\n```\npython -m latex-jinja build\n```\n\n```properties\nINFO Loaded inputs from \"inputs.json\"\nINFO Rendered the template \"template.tex.j2\nINFO Created \"article.pdf\"\n```\n\nThis will populate the template and produces a PDF:\n\n![Example](docs/images/example.png)\n\n## Installing\n\nDownload the [TeX distribution](https://miktex.org/), this includes `pdflatex` which is used by this package.\n\n```bash\npip install latex-jinja\n```\n\n## Documentation\n\nDocumentation and more detailed examples are hosted on [Github Pages](https://joellefkowitz.github.io/latex).\n\n## Tooling\n\n### Dependencies\n\nTo install dependencies:\n\n```bash\nyarn install\npip install .[all]\n```\n\n### Tests\n\nTo run tests:\n\n```bash\nthx test\n```\n\n### Documentation\n\nTo generate the documentation locally:\n\n```bash\nthx docs\n```\n\n### Linters\n\nTo run linters:\n\n```bash\nthx lint\n```\n\n### Formatters\n\nTo run formatters:\n\n```bash\nthx format\n```\n\n## Contributing\n\nPlease read this repository's [Code of Conduct](CODE_OF_CONDUCT.md) which outlines our collaboration standards and the [Changelog](CHANGELOG.md) for details on breaking changes that have been made.\n\nThis repository adheres to semantic versioning standards. For more information on semantic versioning visit [SemVer](https://semver.org).\n\nBump2version is used to version and tag changes. For example:\n\n```bash\nbump2version patch\n```\n\n### Contributors\n\n- [Joel Lefkowitz](https://github.com/joellefkowitz) - Initial work\n\n## Remarks\n\nLots of love to the open source community!\n\n<div align='center'>\n    <img width=200 height=200 src='https://media.giphy.com/media/osAcIGTSyeovPq6Xph/giphy.gif' alt='Be kind to your mind' />\n    <img width=200 height=200 src='https://media.giphy.com/media/KEAAbQ5clGWJwuJuZB/giphy.gif' alt='Love each other' />\n    <img width=200 height=200 src='https://media.giphy.com/media/WRWykrFkxJA6JJuTvc/giphy.gif' alt=\"It's ok to have a bad day\" />\n</div>\n",
    "bugtrack_url": null,
    "license": "# MIT License  Copyright (c) 2024 Joel Lefkowitz  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.",
    "summary": "Latex templating with Jinja and PDF conversion.",
    "version": "0.3.1",
    "project_urls": {
        "homepage": "https://joellefkowitz.github.io/latex",
        "repository": "https://github.com/JoelLefkowitz/latex"
    },
    "split_keywords": [
        "pdf",
        " jinja",
        " latex",
        " template"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "420e3ccc4aaca46f403342d7a10f6578978184899b3bdff4bb0f62f5d1f36e08",
                "md5": "5dee1bc011d0b72d18ff7e5faaa5c5b9",
                "sha256": "bb99aec1e3a2a433ea374341ca12b23dbb3f18a0639a5162b0d97065d53f27d6"
            },
            "downloads": -1,
            "filename": "latex_jinja-0.3.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5dee1bc011d0b72d18ff7e5faaa5c5b9",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 7294,
            "upload_time": "2024-11-29T17:10:03",
            "upload_time_iso_8601": "2024-11-29T17:10:03.279258Z",
            "url": "https://files.pythonhosted.org/packages/42/0e/3ccc4aaca46f403342d7a10f6578978184899b3bdff4bb0f62f5d1f36e08/latex_jinja-0.3.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0ea79510b7abf78b78201430522551d10b4ca37299e28e73f4ce58186e935050",
                "md5": "2a74a60d794cd0da7f9a04a84544afe2",
                "sha256": "eac740d22bae891fcb7b93b3fcf36402be31f34a2b143ddaec6c217bc812ffce"
            },
            "downloads": -1,
            "filename": "latex_jinja-0.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "2a74a60d794cd0da7f9a04a84544afe2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 5229,
            "upload_time": "2024-11-29T17:10:17",
            "upload_time_iso_8601": "2024-11-29T17:10:17.944757Z",
            "url": "https://files.pythonhosted.org/packages/0e/a7/9510b7abf78b78201430522551d10b4ca37299e28e73f4ce58186e935050/latex_jinja-0.3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-29 17:10:17",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "JoelLefkowitz",
    "github_project": "latex",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "latex-jinja"
}
        
Elapsed time: 0.48065s