render-engine


Namerender-engine JSON
Version 2024.1.1 PyPI version JSON
download
home_page
SummaryA Flexible Static Site Generator for Python
upload_time2024-02-13 16:27:56
maintainer
docs_urlNone
author
requires_python>=3.10
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->

[![All Contributors](https://img.shields.io/badge/all_contributors-14-orange.svg?style=flat-square)](#contributors-)

<!-- ALL-CONTRIBUTORS-BADGE:END -->

> **WARNING**
> The 2023.9.1 update changes `site.static_path` to `site.static_paths` any custom output paths will need to be updated to reflect this change. `'output'` is still the default value for `site.static_paths` and will be used if no value is provided.

# Render Engine

[![PyTest](https://github.com/kjaymiller/render_engine/actions/workflows/test.yml/badge.svg)](https://github.com/kjaymiller/render_engine/actions/workflows/test.yml)
[![Discord](https://img.shields.io/discord/1174377880118104156?label=Discord&color=purple)](https://discord.gg/2xMQ4j4d8m)

## Learn More

- [Check out the Documentation](https://render-engine.readthedocs.io/en/latest/)
- [Contributors and Builders, Check out the Wiki](https://github.com/render-engine/render-engine/wiki)
- [Join the community!](https://discord.gg/2xMQ4j4d8m)

## What is RenderEngine

## The _3 layer_ Architecture

- **[Page](.github/render_engine/page.html)** - A single webpage item built from content, a template, raw data, or a combination of those things.
- **[Collection](.github/render_engine/collection.html)** - A group of webpages built from the same template, organized in a single directory
- **[Site](.github/render_engine/site.html)** - The container that helps to render all Pages and Collections with uniform settings and variables

## Installing Render Engine

To use the render engine, you must have Python 3.10 installed. You can download Python from [python.org](https://python.org).

- Linux/MacOS: [python.org](https://python.org)
- Windows: [Microsoft Store](https://apps.microsoft.com/store/detail/python-311/9NRWMJP3717K)

Render Engine is available in PyPI and can be installed using pip:

```bash
pip install render-engine
```

## Getting Started

Check out the [Getting Started](https://render-engine.readthedocs.io/en/latest/page/) Section in the [Documentation](https://render-engine.readthedocs.io)

## Contributors

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
  <tbody>
    <tr>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Tashuuuu"><img src="https://avatars.githubusercontent.com/u/85075827?v=4?s=57" width="57px;" alt="Akriti Sengar"/><br /><sub><b>Akriti Sengar</b></sub></a><br /><a href="#tool-Tashuuuu" title="Tools">🔧</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://tonybaloney.github.io/"><img src="https://avatars.githubusercontent.com/u/1532417?v=4?s=57" width="57px;" alt="Anthony Shaw"/><br /><sub><b>Anthony Shaw</b></sub></a><br /><a href="https://github.com/render-engine/render-engine/commits?author=tonybaloney" title="Documentation">📖</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/mannyanebi"><img src="https://avatars.githubusercontent.com/u/25439000?v=4?s=57" width="57px;" alt="Emmanuel Anebi"/><br /><sub><b>Emmanuel Anebi</b></sub></a><br /><a href="#plugin-mannyanebi" title="Plugin/utility libraries">🔌</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://webology.dev"><img src="https://avatars.githubusercontent.com/u/50527?v=4?s=57" width="57px;" alt="Jeff Triplett"/><br /><sub><b>Jeff Triplett</b></sub></a><br /><a href="https://github.com/render-engine/render-engine/commits?author=jefftriplett" title="Documentation">📖</a> <a href="#mentoring-jefftriplett" title="Mentoring">🧑‍🏫</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://linktr.ee/john0isaac"><img src="https://avatars.githubusercontent.com/u/64026625?v=4?s=57" width="57px;" alt="John Aziz"/><br /><sub><b>John Aziz</b></sub></a><br /><a href="https://github.com/render-engine/render-engine/commits?author=john0isaac" title="Documentation">📖</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://www.jonafato.com"><img src="https://avatars.githubusercontent.com/u/392720?v=4?s=57" width="57px;" alt="Jon Banafato"/><br /><sub><b>Jon Banafato</b></sub></a><br /><a href="https://github.com/render-engine/render-engine/commits?author=jonafato" title="Code">💻</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/jlgimeno"><img src="https://avatars.githubusercontent.com/u/17421585?v=4?s=57" width="57px;" alt="Jorge L. Gimeno"/><br /><sub><b>Jorge L. Gimeno</b></sub></a><br /><a href="https://github.com/render-engine/render-engine/commits?author=jlgimeno" title="Documentation">📖</a></td>
    </tr>
    <tr>
      <td align="center" valign="top" width="14.28%"><a href="http://lauralangdon.io"><img src="https://avatars.githubusercontent.com/u/48335772?v=4?s=57" width="57px;" alt="Laura Langdon"/><br /><sub><b>Laura Langdon</b></sub></a><br /><a href="https://github.com/render-engine/render-engine/commits?author=LauraLangdon" title="Documentation">📖</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Mahhheshh"><img src="https://avatars.githubusercontent.com/u/100200105?v=4?s=57" width="57px;" alt="Mahhheshh"/><br /><sub><b>Mahhheshh</b></sub></a><br /><a href="https://github.com/render-engine/render-engine/commits?author=Mahhheshh" title="Documentation">📖</a> <a href="https://github.com/render-engine/render-engine/commits?author=Mahhheshh" title="Code">💻</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://www.pythonbynight.com"><img src="https://avatars.githubusercontent.com/u/46942991?v=4?s=57" width="57px;" alt="Mario Munoz"/><br /><sub><b>Mario Munoz</b></sub></a><br /><a href="https://github.com/render-engine/render-engine/commits?author=tataraba" title="Code">💻</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://www.pamelafox.org"><img src="https://avatars.githubusercontent.com/u/297042?v=4?s=57" width="57px;" alt="Pamela Fox"/><br /><sub><b>Pamela Fox</b></sub></a><br /><a href="https://github.com/render-engine/render-engine/commits?author=pamelafox" title="Documentation">📖</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/viktoriussuwandi"><img src="https://avatars.githubusercontent.com/u/68414300?v=4?s=57" width="57px;" alt="Viktorius Suwandi"/><br /><sub><b>Viktorius Suwandi</b></sub></a><br /><a href="https://github.com/render-engine/render-engine/commits?author=viktoriussuwandi" title="Code">💻</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/VinayakG311"><img src="https://avatars.githubusercontent.com/u/96966973?v=4?s=57" width="57px;" alt="VinayakG311"/><br /><sub><b>VinayakG311</b></sub></a><br /><a href="#plugin-VinayakG311" title="Plugin/utility libraries">🔌</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Izaan17"><img src="https://avatars.githubusercontent.com/u/93177492?v=4?s=57" width="57px;" alt="izaan17"/><br /><sub><b>izaan17</b></sub></a><br /><a href="#plugin-izaan17" title="Plugin/utility libraries">🔌</a></td>
    </tr>
  </tbody>
</table>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

### Sponsors at the $20/month and Higher Level

- [Brian Douglas](https://github.com/bdougie)

Thank you to them and all of those who continue to support this project!

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "render-engine",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "",
    "keywords": "",
    "author": "",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/e9/92/3e92e597ede511325573954b371e20fc90cf0f49fed7c862ded7c833bf46/render_engine-2024.1.1.tar.gz",
    "platform": null,
    "description": "<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->\n\n[![All Contributors](https://img.shields.io/badge/all_contributors-14-orange.svg?style=flat-square)](#contributors-)\n\n<!-- ALL-CONTRIBUTORS-BADGE:END -->\n\n> **WARNING**\n> The 2023.9.1 update changes `site.static_path` to `site.static_paths` any custom output paths will need to be updated to reflect this change. `'output'` is still the default value for `site.static_paths` and will be used if no value is provided.\n\n# Render Engine\n\n[![PyTest](https://github.com/kjaymiller/render_engine/actions/workflows/test.yml/badge.svg)](https://github.com/kjaymiller/render_engine/actions/workflows/test.yml)\n[![Discord](https://img.shields.io/discord/1174377880118104156?label=Discord&color=purple)](https://discord.gg/2xMQ4j4d8m)\n\n## Learn More\n\n- [Check out the Documentation](https://render-engine.readthedocs.io/en/latest/)\n- [Contributors and Builders, Check out the Wiki](https://github.com/render-engine/render-engine/wiki)\n- [Join the community!](https://discord.gg/2xMQ4j4d8m)\n\n## What is RenderEngine\n\n## The _3 layer_ Architecture\n\n- **[Page](.github/render_engine/page.html)**\u00a0- A single webpage item built from content, a template, raw data, or a combination of those things.\n- **[Collection](.github/render_engine/collection.html)**\u00a0- A group of webpages built from the same template, organized in a single directory\n- **[Site](.github/render_engine/site.html)** - The container that helps to render all Pages and Collections with uniform settings and variables\n\n## Installing Render Engine\n\nTo use the render engine, you must have Python 3.10 installed. You can download Python from [python.org](https://python.org).\n\n- Linux/MacOS: [python.org](https://python.org)\n- Windows: [Microsoft Store](https://apps.microsoft.com/store/detail/python-311/9NRWMJP3717K)\n\nRender Engine is available in PyPI and can be installed using pip:\n\n```bash\npip install render-engine\n```\n\n## Getting Started\n\nCheck out the [Getting Started](https://render-engine.readthedocs.io/en/latest/page/) Section in the [Documentation](https://render-engine.readthedocs.io)\n\n## Contributors\n\n<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->\n<!-- prettier-ignore-start -->\n<!-- markdownlint-disable -->\n<table>\n  <tbody>\n    <tr>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/Tashuuuu\"><img src=\"https://avatars.githubusercontent.com/u/85075827?v=4?s=57\" width=\"57px;\" alt=\"Akriti Sengar\"/><br /><sub><b>Akriti Sengar</b></sub></a><br /><a href=\"#tool-Tashuuuu\" title=\"Tools\">\ud83d\udd27</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://tonybaloney.github.io/\"><img src=\"https://avatars.githubusercontent.com/u/1532417?v=4?s=57\" width=\"57px;\" alt=\"Anthony Shaw\"/><br /><sub><b>Anthony Shaw</b></sub></a><br /><a href=\"https://github.com/render-engine/render-engine/commits?author=tonybaloney\" title=\"Documentation\">\ud83d\udcd6</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/mannyanebi\"><img src=\"https://avatars.githubusercontent.com/u/25439000?v=4?s=57\" width=\"57px;\" alt=\"Emmanuel Anebi\"/><br /><sub><b>Emmanuel Anebi</b></sub></a><br /><a href=\"#plugin-mannyanebi\" title=\"Plugin/utility libraries\">\ud83d\udd0c</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://webology.dev\"><img src=\"https://avatars.githubusercontent.com/u/50527?v=4?s=57\" width=\"57px;\" alt=\"Jeff Triplett\"/><br /><sub><b>Jeff Triplett</b></sub></a><br /><a href=\"https://github.com/render-engine/render-engine/commits?author=jefftriplett\" title=\"Documentation\">\ud83d\udcd6</a> <a href=\"#mentoring-jefftriplett\" title=\"Mentoring\">\ud83e\uddd1\u200d\ud83c\udfeb</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://linktr.ee/john0isaac\"><img src=\"https://avatars.githubusercontent.com/u/64026625?v=4?s=57\" width=\"57px;\" alt=\"John Aziz\"/><br /><sub><b>John Aziz</b></sub></a><br /><a href=\"https://github.com/render-engine/render-engine/commits?author=john0isaac\" title=\"Documentation\">\ud83d\udcd6</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://www.jonafato.com\"><img src=\"https://avatars.githubusercontent.com/u/392720?v=4?s=57\" width=\"57px;\" alt=\"Jon Banafato\"/><br /><sub><b>Jon Banafato</b></sub></a><br /><a href=\"https://github.com/render-engine/render-engine/commits?author=jonafato\" title=\"Code\">\ud83d\udcbb</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/jlgimeno\"><img src=\"https://avatars.githubusercontent.com/u/17421585?v=4?s=57\" width=\"57px;\" alt=\"Jorge L. Gimeno\"/><br /><sub><b>Jorge L. Gimeno</b></sub></a><br /><a href=\"https://github.com/render-engine/render-engine/commits?author=jlgimeno\" title=\"Documentation\">\ud83d\udcd6</a></td>\n    </tr>\n    <tr>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"http://lauralangdon.io\"><img src=\"https://avatars.githubusercontent.com/u/48335772?v=4?s=57\" width=\"57px;\" alt=\"Laura Langdon\"/><br /><sub><b>Laura Langdon</b></sub></a><br /><a href=\"https://github.com/render-engine/render-engine/commits?author=LauraLangdon\" title=\"Documentation\">\ud83d\udcd6</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/Mahhheshh\"><img src=\"https://avatars.githubusercontent.com/u/100200105?v=4?s=57\" width=\"57px;\" alt=\"Mahhheshh\"/><br /><sub><b>Mahhheshh</b></sub></a><br /><a href=\"https://github.com/render-engine/render-engine/commits?author=Mahhheshh\" title=\"Documentation\">\ud83d\udcd6</a> <a href=\"https://github.com/render-engine/render-engine/commits?author=Mahhheshh\" title=\"Code\">\ud83d\udcbb</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://www.pythonbynight.com\"><img src=\"https://avatars.githubusercontent.com/u/46942991?v=4?s=57\" width=\"57px;\" alt=\"Mario Munoz\"/><br /><sub><b>Mario Munoz</b></sub></a><br /><a href=\"https://github.com/render-engine/render-engine/commits?author=tataraba\" title=\"Code\">\ud83d\udcbb</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://www.pamelafox.org\"><img src=\"https://avatars.githubusercontent.com/u/297042?v=4?s=57\" width=\"57px;\" alt=\"Pamela Fox\"/><br /><sub><b>Pamela Fox</b></sub></a><br /><a href=\"https://github.com/render-engine/render-engine/commits?author=pamelafox\" title=\"Documentation\">\ud83d\udcd6</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/viktoriussuwandi\"><img src=\"https://avatars.githubusercontent.com/u/68414300?v=4?s=57\" width=\"57px;\" alt=\"Viktorius Suwandi\"/><br /><sub><b>Viktorius Suwandi</b></sub></a><br /><a href=\"https://github.com/render-engine/render-engine/commits?author=viktoriussuwandi\" title=\"Code\">\ud83d\udcbb</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/VinayakG311\"><img src=\"https://avatars.githubusercontent.com/u/96966973?v=4?s=57\" width=\"57px;\" alt=\"VinayakG311\"/><br /><sub><b>VinayakG311</b></sub></a><br /><a href=\"#plugin-VinayakG311\" title=\"Plugin/utility libraries\">\ud83d\udd0c</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/Izaan17\"><img src=\"https://avatars.githubusercontent.com/u/93177492?v=4?s=57\" width=\"57px;\" alt=\"izaan17\"/><br /><sub><b>izaan17</b></sub></a><br /><a href=\"#plugin-izaan17\" title=\"Plugin/utility libraries\">\ud83d\udd0c</a></td>\n    </tr>\n  </tbody>\n</table>\n\n<!-- markdownlint-restore -->\n<!-- prettier-ignore-end -->\n\n<!-- ALL-CONTRIBUTORS-LIST:END -->\n<!-- prettier-ignore-start -->\n<!-- markdownlint-disable -->\n\n<!-- markdownlint-restore -->\n<!-- prettier-ignore-end -->\n\n<!-- ALL-CONTRIBUTORS-LIST:END -->\n\n### Sponsors at the $20/month and Higher Level\n\n- [Brian Douglas](https://github.com/bdougie)\n\nThank you to them and all of those who continue to support this project!\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A Flexible Static Site Generator for Python",
    "version": "2024.1.1",
    "project_urls": {
        "documentation": "https://render-engine.readthedocs.io/en/latest/",
        "homepage": "https://github.com/kjaymiller/render_engine/",
        "repository": "https://github.com/kjaymiller/render_engine/"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f18bc332113bb9cbe9feb232931d8cc08019a8bb2731f411499efa0b0be45aef",
                "md5": "d1c654e50005475ca8b18f084dba52a0",
                "sha256": "00da76baa55b5f6ed8792567fc0e386c9938a7a3a1c702c5bf1c11b5d431affa"
            },
            "downloads": -1,
            "filename": "render_engine-2024.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d1c654e50005475ca8b18f084dba52a0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 30589,
            "upload_time": "2024-02-13T16:27:53",
            "upload_time_iso_8601": "2024-02-13T16:27:53.492679Z",
            "url": "https://files.pythonhosted.org/packages/f1/8b/c332113bb9cbe9feb232931d8cc08019a8bb2731f411499efa0b0be45aef/render_engine-2024.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e9923e92e597ede511325573954b371e20fc90cf0f49fed7c862ded7c833bf46",
                "md5": "5546039f276e5e1b1619adf92ed450ac",
                "sha256": "54467f9ba10e5d93d15dc308f49cae5cfb2087934073600f9cd8a0c4085c3e10"
            },
            "downloads": -1,
            "filename": "render_engine-2024.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "5546039f276e5e1b1619adf92ed450ac",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 11811322,
            "upload_time": "2024-02-13T16:27:56",
            "upload_time_iso_8601": "2024-02-13T16:27:56.606736Z",
            "url": "https://files.pythonhosted.org/packages/e9/92/3e92e597ede511325573954b371e20fc90cf0f49fed7c862ded7c833bf46/render_engine-2024.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-13 16:27:56",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "kjaymiller",
    "github_project": "render_engine",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "render-engine"
}
Elapsed time: 0.22119s