.coveragerc

@@ -1,3 +1,9 @@
 [run]
+branch = true
 source = bandit
 omit = */tests*
+
+[report]
+fail_under = 85
+show_missing = true
+skip_covered = true

.github/workflows/release.yml

@@ -0,0 +1,28 @@
+# This workflows will upload a Python Package using Twine when a release is created
+# For more information see:
+# https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  release:
+    runs-on: ubuntu-20.04
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v2
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: |
+        python setup.py sdist bdist_wheel
+        twine upload dist/*

.github/workflows/test.yml

@@ -0,0 +1,83 @@
+name: lint-test
+
+on:
+  pull_request:
+    branches:
+      - develop
+  push:
+    branches:
+      - master
+      - develop
+  schedule:
+    # run once a week on early monday mornings
+    - cron: '22 2 * * 1'
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - uses: pre-commit/action@v2.0.0
+
+  test:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        # tox-gh-actions will only run the tox environments which match the currently
+        # running python-version. See [gh-actions] in tox.ini for the mapping
+        python-version: ['3.6', '3.7', '3.8', '3.9', '3.10']
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r dev-requirements.txt
+      - name: Test with tox
+        run: tox
+
+  coverage:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - name: Cache pip
+        uses: actions/cache@v2
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('dev-requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+            ${{ runner.os }}-
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r dev-requirements.txt
+      - name: Run coverage report
+        run: |
+          coverage run runtests.py
+          coverage report
+
+  build-docs:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - name: Cache pip
+        uses: actions/cache@v2
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('dev-requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+            ${{ runner.os }}-
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r dev-requirements.txt
+      - name: Build docs
+        run: sphinx-build docs docs/_build/html

.pre-commit-config.yaml

@@ -0,0 +1,30 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.3.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-json
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: check-yaml
+      - id: debug-statements
+      - id: detect-private-key
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: trailing-whitespace
+
+  - repo: https://github.com/psf/black
+    rev: 22.6.0
+    hooks:
+      - id: black
+
+  - repo: https://github.com/pycqa/isort
+    rev: 5.10.0
+    hooks:
+      - id: isort
+
+  - repo: https://gitlab.com/pycqa/flake8
+    rev: 5.0.4
+    hooks:
+      - id: flake8

.python-version

@@ -0,0 +1,4 @@
+3.9.0
+3.8.6
+3.7.9
+3.6.12

AUTHORS

@@ -12,3 +12,4 @@ Arne de Laat (@153957)
 Jaap Roes (@jaap3)
 Tony S Yu (@tonysyu)
 Dan Poirier (@dpoirier)
+Petr Dlouhý (@PetrDlouhy)

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2011-2018, Caktus Consulting Group, LLC
+Copyright (c) 2011-2021, Caktus Consulting Group, LLC
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,

README.rst

@@ -1,4 +1,4 @@
-Django-Email-Bandit
+django-email-bandit
 ==============================
 
 .. sidebar:: Build Status
@@ -16,21 +16,21 @@ logging. Mixin classes are provided to use the same hijack logic for any existin
 email backend such as `django-ses <https://github.com/hmarr/django-ses>`_.
 
 .. |master-status| image::
-    https://api.travis-ci.org/caktus/django-email-bandit.svg?branch=master
+    https://github.com/caktus/django-email-bandit/workflows/lint-test/badge.svg?branch=master
     :alt: Build Status
-    :target: https://travis-ci.org/caktus/django-email-bandit
+    :target: https://github.com/caktus/django-email-bandit/actions?query=branch%3Amaster
 
 .. |develop-status| image::
-    https://api.travis-ci.org/caktus/django-email-bandit.svg?branch=develop
+    https://github.com/caktus/django-email-bandit/workflows/lint-test/badge.svg?branch=develop
     :alt: Build Status
-    :target: https://travis-ci.org/caktus/django-email-bandit
+    :target: https://github.com/caktus/django-email-bandit/actions?query=branch%3Adevelop
 
 
 Requirements
 -------------------------------
 
-- Python 2.7 or 3.5+
-- Django >= 1.8 (supported versions)
+- Python >= 3.6
+- Django >= 2.2 (supported versions)
 
 
 Installation
@@ -40,6 +40,14 @@ To install django-email-bandit via pip::
 
     pip install django-email-bandit
 
+Add django-email-bandit to your installed apps::
+
+    INSTALLED_APPS = (
+        ...
+        'bandit',
+        ...
+    )
+
 For your test environment you should enable the backend::
 
     EMAIL_BACKEND = 'bandit.backends.smtp.HijackSMTPBackend'
@@ -48,7 +56,7 @@ and set the email which will receive all of the emails::
 
     BANDIT_EMAIL = 'bandit@example.com'
 
-or even multiple addresses:
+or even multiple addresses::
 
     BANDIT_EMAIL = ['bandit@example.com', 'accomplice@example.com']
 
@@ -66,11 +74,33 @@ Documentation
 Full project documentation is on `Read the Docs <https://django-email-bandit.readthedocs.org/>`_.
 
 
+Maintainer Information
+-------------------------------
+
+We use Github Actions to lint (using pre-commit, black, isort, and flake8),
+test (using tox and tox-gh-actions), calculate coverage (using coverage), and build
+documentation (using sphinx).
+
+We have a local script to do these actions locally, named ``maintain.sh``::
+
+  $ ./maintain.sh
+
+A Github Action workflow also builds and pushes a new package to PyPI whenever a new
+Release is created in Github. This uses a project-specific PyPI token, as described in
+the `PyPI documentation here <https://pypi.org/help/#apitoken>`_. That token has been
+saved in the ``PYPI_PASSWORD`` settings for this repo, but has not been saved anywhere
+else so if it is needed for any reason, the current one should be deleted and a new one
+generated.
+
+As always, be sure to bump the version in ``bandit/__init__.py`` before creating a
+Release, so that the proper version gets pushed to PyPI.
+
+
 Questions or Issues?
 -------------------------------
 
 If you have questions, issues or requests for improvements please let us know on
 `Github <https://github.com/caktus/django-email-bandit/issues>`_.
 
 Development sponsored by `Caktus Consulting Group, LLC
-<http://www.caktusgroup.com/services>`_.
+<https://www.caktusgroup.com/services>`_.

bandit/__init__.py

@@ -3,24 +3,26 @@
 """
 
 __version_info__ = {
-    'major': 1,
-    'minor': 5,
-    'micro': 0,
-    'releaselevel': 'final',
+    "major": 2,
+    "minor": 0,
+    "micro": 0,
+    "releaselevel": "final",
 }
 
 
 def get_version():
     """
     Return the formatted version information
     """
-    vers = ["%(major)i.%(minor)i" % __version_info__, ]
+    vers = [
+        "%(major)i.%(minor)i" % __version_info__,
+    ]
 
-    if __version_info__['micro']:
+    if __version_info__["micro"]:
         vers.append(".%(micro)i" % __version_info__)
-    if __version_info__['releaselevel'] != 'final':
-        vers.append('%(releaselevel)s' % __version_info__)
-    return ''.join(vers)
+    if __version_info__["releaselevel"] != "final":
+        vers.append("%(releaselevel)s" % __version_info__)
+    return "".join(vers)
 
 
 __version__ = get_version()