Metadata-Version: 2.4
Name: ddmail_openpgp_encryptor
Version: 0.0.2
Summary: Program to encrypt incoming emails with OpenPGP for the DDMail project.
Project-URL: Homepage, https://github.com/drzobin/ddmail_openpgp_encryptor
Project-URL: Issues, https://github.com/drzobin/ddmail_openpgp_encryptor/issues
Author-email: Robin Larsson <me@drz.se>
License-Expression: AGPL-3.0
License-File: LICENSE
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Requires-Dist: aiosmtpd
Requires-Dist: ddmail-validators
Requires-Dist: mysqlclient
Requires-Dist: python-gnupg
Requires-Dist: sqlalchemy
Requires-Dist: toml
Provides-Extra: dev
Requires-Dist: aiosmtpd; extra == 'dev'
Requires-Dist: ddmail-validators; extra == 'dev'
Requires-Dist: flake8; extra == 'dev'
Requires-Dist: hatchling; extra == 'dev'
Requires-Dist: mysqlclient; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: python-gnupg; extra == 'dev'
Requires-Dist: sqlalchemy; extra == 'dev'
Requires-Dist: toml; extra == 'dev'
Requires-Dist: twine; extra == 'dev'
Provides-Extra: test
Requires-Dist: aiosmtpd; extra == 'test'
Requires-Dist: ddmail-validators; extra == 'test'
Requires-Dist: flake8; extra == 'test'
Requires-Dist: mysqlclient; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Requires-Dist: python-gnupg; extra == 'test'
Requires-Dist: sqlalchemy; extra == 'test'
Requires-Dist: toml; extra == 'test'
Description-Content-Type: text/markdown

# What is ddmail_openpgp_encryptor
Program to encrypt incoming emails with OpenPGP for the ddmail project.

## What is DDMail
DDMail is a e-mail system/service that prioritizes security. A current production example can be found at www.ddmail.se

## Operating system
Developt for and tested on debian 12.

## Installing using pip
`pip install ddmail-openpgp-encryptor`

## Building and installing from source using hatchling.
Step 1: clone github repo<br>
`git clone https://github.com/drzobin/ddmail_openpgp_encryptor [code path]`<br>
`cd [code path]`<br>
<br>
Step 2: Setup python virtual environments<br>
`python -m venv [venv path]`<br>
`source [venv path]/bin/activate`<br>
<br>
Step 3: Install package and required dependencies<br>
`pip install -e .[dev]`<br>
<br>
Step 4: Build package<br>
`python -m pip install --upgrade build`<br>
`python -m build `<br><br>
Packages is now located under [code path]/dist folder<br>

## Run
`source [venv path]/bin/activate`<br>
`ddmail_openpgp_encryptor --config-file [config file].toml`

## Coding
Follow PEP8 and PEP257. Use Flake8 with flake8-docstrings for linting. Strive for 100% test coverage.
