Skip to main content

emaillib

A simple library to ease the sending of emails with utf8 and attachments.

Development Workflow

The workflow supports the following steps

  • lint

  • test

  • build

  • document

  • upload

  • graph

These actions are supported out of the box by the corresponding scripts under _CI/scripts directory with sane defaults based on best practices. Sourcing setup_aliases.ps1 for windows powershell or setup_aliases.sh in bash on Mac or Linux will provide with handy aliases for the shell of all those commands prepended with an underscore.

The bootstrap script creates a .venv directory inside the project directory hosting the virtual environment. It uses pipenv for that. It is called by all other scripts before they do anything. So one could simple start by calling _lint and that would set up everything before it tried to actually lint the project

Once the code is ready to be delivered the _tag script should be called accepting one of three arguments, patch, minor, major following the semantic versioning scheme. So for the initial delivery one would call

$ _tag –minor

which would bump the version of the project to 0.1.0 tag it in git and do a push and also ask for the change and automagically update HISTORY.rst with the version and the change provided.

So the full workflow after git is initialized is:

  • repeat as necessary (of course it could be test - code - lint :) )

    • code

    • lint

    • test

  • commit and push

  • develop more through the code-lint-test cycle

  • tag (with the appropriate argument)

  • build

  • upload (if you want to host your package in pypi)

  • document (of course this could be run at any point)

Important Information

This template is based on pipenv. In order to be compatible with requirements.txt so the actual created package can be used by any part of the existing python ecosystem some hacks were needed. So when building a package out of this do not simple call

$ python setup.py sdist bdist_egg

as this will produce an unusable artifact with files missing. Instead use the provided build and upload scripts that create all the necessary files in the artifact.

Project Features

  • Handles subject and message body as utf-8 by default

  • Handles html and plain text

  • Handles attachments either as list or comma delimited value arguments

  • Supports CC and BCC

  • Simply validates the provided recipient addresses

History

0.0.1 (16-09-2017)

  • First code creation

1.0.0 (07-07-2021)

  • Dropped support for python2.7, updated the template and setup a pipeline for release.

Metadata

Release files for emaillib 1.0.0

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

Source distribution (sdist)

Source distribution for emaillib 1.0.0
File Size Uploaded Provenance Actions
emaillib-1.0.0.tar.gz 49.4 kB Without provenance Details for emaillib-1.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for emaillib 1.0.0
File Interpreter ABI Platform Actions
emaillib-1.0.0-py3.7.egg Legacy Egg format - - Details for emaillib-1.0.0-py3.7.egg

Total release size: 77.8 kB

Release files / emaillib-1.0.0.tar.gz

Download URL emaillib-1.0.0.tar.gz
Size 49.4 kB
Tags Source
SHA-256 checksum
How to use checksums
08da02a4d9fbf490d92146b43ee3d86da901f58647f66ce3f4ef6c3bed9d95f0
BLAKE2b-256 checksum
How to use checksums
f1af399e14d66719ed4b4a917d873f20e11e39c53605eb47a863b5d8f7442608
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.7.0 requests/2.25.1 setuptools/57.0.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.7.10

Release files / emaillib-1.0.0-py3.7.egg

Download URL emaillib-1.0.0-py3.7.egg
Size 28.4 kB
Tags Egg
SHA-256 checksum
How to use checksums
b256ffffe8d98cb48755c34c086ff54794421d4aa0697cb0f6f92f53a1e63c9a
BLAKE2b-256 checksum
How to use checksums
1bf6bb7f9a226d37e8e808a1be4fd2334c13151c4b4e68f63cf0a03fae655086
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.7.0 requests/2.25.1 setuptools/57.0.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.7.10

Security for emaillib 1.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page