Metadata-Version: 2.1
Name: rh_email_tpl
Version: 0.1.11
Summary: Internal RegioHelden tool for building styled html emails
Home-page: 
Download-URL: 
Author: RegioHelden <entwicklung@regiohelden.de>
Author-email: entwicklung@regiohelden.de
License: UNKNOWN
Keywords: django,emails,html-email
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Monitoring
Description-Content-Type: text/markdown

# RegioHelden Email template

`rh_email_tpl` is a django app used to render RegioHelden styled HTML emails. It provides also multiple Django 
templatetags used as helpers for building HTML emails.

This project is meant to be used internally by RegioHelden organisation, as it has the company styles and logos.

## Installation

Simply run:
```
pip install rh_email_tpl
```

And add `rh_email_tpl` to your django `INSTALLED_APPS`. I.e.: in `settings.py` add:
```
INSTALLED_APPS = [
  ...
  "rh_email_tpl",
  ...
]
```

## Making a new release

[bumpversion](https://github.com/peritus/bumpversion) is used to manage releases.

Add your changes to the [CHANGELOG](./CHANGELOG.md) and run `bumpversion <major|minor|patch>`, then push (including tags)

## This project uses Black

We use the python [Black](https://black.readthedocs.io/en/stable/) code formatter.

If you would like to format code directly in your IDE, take a look [here](https://black.readthedocs.io/en/stable/editor_integration.html). This is possible in PyCharm, Sublime Text, VSCode ...

To ensure that your push will not be rejected, make sure to install [pre-commit](https://pre-commit.com/#install) on your machine.
Then inside the project folder run the following:
```sh
pre-commit install
```

This will install the required pre-commit hooks that will run everytime you will commit something.
For more details you can check the `.pre-commit-config.yaml` file


