Development guide

Install

Currently py27 is the only supported python version. It is recommended that you install this tool within a fresh virtual environment. More info on https://virtualenv.pypa.io/en/stable/userguide/.

> cd ${repo_root}
> ${envpip} install -r requirements.txt -r requirements_${darwin/linux}.txt
> ${envpip} install .

Package depends on libsodium. Make sure to install:

> brew install libsodium # macos
> apt-get install libsodium-dev # linux

Testing

We use tox as the project's test runner. Make sure you have tox >= 3.5.3 installed in your python environment.

Run all tests

> cd ${repo_core}
> tox

Unit tests

> tox -e unit-${darwin/linux}

Integration tests

> tox -e integration-${darwin/linux}

Linting

We use flake8 as project's linter. Enforcement via:

> tox -e flake8

Some helper CLIs through make

There are some handy make commands that you can use. Check out usage:

> cd ${repo-root}
> make
USAGE:
> make [
	build: build python package
	unit-test: run unit tests with tox
	integration-test: run integration tests with tox
	test: run all tests
	lint: run flake8 linter with tox

	docker-build: build python package in a linux container
	docker-unit-test: run unit tests with tox in a linux container
	docker-integration-test: run integration tests with tox in a linux container
	docker-test: run all tests in a linux container
	docker-build-runtime: build docker image `relay:${VERSION}` that has installed mail-relay pacakge pulled from pypi
	shell: get interactive shell to builder/tester container

	clean: ...

	publish-pypi: publish package on pypi
	publish-docker-hub: publish image on docker hub
	release: manage release on github, publish on pypi as well as docker hub
]

Release files for mail-relay 0.1.16

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mail-relay 0.1.16
File	Size	Uploaded
mail-relay-0.1.16.tar.gz	51.8 kB	Nov 22, 2019	Details

Release files / mail-relay-0.1.16.tar.gz

Download URL	mail-relay-0.1.16.tar.gz
Size	51.8 kB
Tags	Source
SHA-256 checksum How to use checksums	`a20b05263bdb73acf0027aae9fbcf821dd172914e080b9d686fdde203d4b9d27`
BLAKE2b-256 checksum How to use checksums	`cbb3cd7408832414e5c5dffc63766c73fb11e73139767d8a442e669f88bc6f2a`
Upload date	Nov 22, 2019
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/1.15.0 pkginfo/1.5.0.1 requests/2.20.1 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/2.7.14`