Merge pull request #358 from jazzband/gha

Migrate to GitHub Actions.

Author: jezdez

.github/workflows/release.yml

@@ -0,0 +1,53 @@
+name: Release
+
+on:
+  push:
+    tags:
+    - '*'
+
+jobs:
+  build:
+    if: github.repository == 'jazzband/django-newsletter'
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+
+      - name: Get pip cache dir
+        id: pip-cache
+        run: |
+          echo "::set-output name=dir::$(pip cache dir)"
+
+      - name: Cache
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.pip-cache.outputs.dir }}
+          key: release-${{ hashFiles('**/setup.py') }}-${{ hashFiles('**/tox.ini') }}
+          restore-keys: |
+            release-
+
+      - name: Install dependencies
+        run: |
+          python -m pip install -U pip
+          python -m pip install -U setuptools twine wheel
+
+      - name: Build package
+        run: |
+          python setup.py --version
+          python setup.py sdist --format=gztar bdist_wheel
+          twine check dist/*
+
+      - name: Upload packages to Jazzband
+        if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+        uses: pypa/gh-action-pypi-publish@master
+        with:
+          user: jazzband
+          password: ${{ secrets.JAZZBAND_RELEASE_KEY }}
+          repository_url: https://jazzband.co/projects/django-newsletter/upload

.github/workflows/test.yml

@@ -0,0 +1,52 @@
+name: Test
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    name: build (Python ${{ matrix.python-version }}, Django ${{ matrix.django-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      max-parallel: 5
+      matrix:
+        python-version: ['3.6', '3.7', '3.8', '3.9']
+        django-version: ['2.2', '3.0', '3.1', 'main']
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Get pip cache dir
+      id: pip-cache
+      run: |
+        echo "::set-output name=dir::$(pip cache dir)"
+
+    - name: Cache
+      uses: actions/cache@v2
+      with:
+        path: ${{ steps.pip-cache.outputs.dir }}
+        key:
+          ${{ matrix.python-version }}-v1-${{ hashFiles('**/setup.py') }}-${{ hashFiles('**/tox.ini') }}
+        restore-keys: |
+          ${{ matrix.python-version }}-v1-
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install --upgrade tox tox-gh-actions
+
+    - name: Tox tests
+      run: |
+        tox -v
+      env:
+        DJANGO: ${{ matrix.django-version }}
+
+    - name: Upload coverage
+      uses: codecov/codecov-action@v1
+      with:
+        name: Python ${{ matrix.python-version }}

.gitignore

@@ -16,3 +16,5 @@ django_setuptest*
 docs/_*
 .idea/
 venv/
+coverage.xml
+.tox

.landscape.yml

@@ -13,6 +13,6 @@ Thanks for your awesome contrib! If you'd like to have your code included in mas
 couple of things you have to take care of though:
 
 1. Ensure that the way you implemented the functionality is generic enough for other users to make use of and does not degrade the performance of existing users. If you unsure about this, create an issue with proposed functionality to discuss with the collaborators first.
-2. Make sure the tests are passing. In any case, Travis should report passing tests.
-3. Extended tests to cover any additional code included in your commit. In any case, the coveralls report should report equal or increased coverage.
+2. Make sure the tests are passing. In any case, GitHub Actions should report passing tests.
+3. Extended tests to cover any additional code included in your commit. In any case, the Codecov report should report equal or increased coverage.
 4. Make sure that any added or changed functionality is documented in the Sphinx documentation.

.travis.yml

@@ -5,11 +5,12 @@ django-newsletter
 .. image:: https://img.shields.io/pypi/v/django-newsletter.svg
     :target: https://pypi.python.org/pypi/django-newsletter
 
-.. image:: https://img.shields.io/travis/jazzband/django-newsletter/master.svg
-    :target: http://travis-ci.org/jazzband/django-newsletter
+.. image:: https://github.com/jazzband/django-newsletter/workflows/Test/badge.svg
+   :target: https://github.com/jazzband/django-newsletter/actions
+   :alt: GitHub Actions
 
-.. image:: https://coveralls.io/repos/github/jazzband/django-newsletter/badge.svg?branch=master
-	:target: https://coveralls.io/github/jazzband/django-newsletter?branch=master
+.. image:: https://codecov.io/gh/jazzband/django-newsletter/branch/master/graph/badge.svg
+  :target: https://codecov.io/gh/jazzband/django-newsletter
 
 .. image:: https://jazzband.co/static/img/badge.svg
     :target: https://jazzband.co/
@@ -58,7 +59,7 @@ Fairly extensive tests are available for internal frameworks, web
 (un)subscription and mail sending. Sending a newsletter to large groups of recipients
 (+15k) has been confirmed to work in multiple production environments. Tests
 for pull req's and the master branch are automatically run through
-`Travis CI <http://travis-ci.org/jazzband/django-newsletter>`_.
+`GitHub Actions <https://github.com/jazzband/django-newsletter/actions>`_.
 
 Contributing
 =============

CONTRIBUTING.rst

@@ -11,7 +11,10 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
+import os
+import sys
+from pkg_resources import get_distribution
+
 
 # Determine whether rendering on RTD
 on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
@@ -80,10 +83,9 @@
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
-# The short X.Y version.
-version = '0.5'
-# The full version, including alpha/beta/rc tags.
-release = '0.5.1'
+release = get_distribution('django-newsletter').version
+# for example take major/minor
+version = '.'.join(release.split('.')[:2])
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

Pipfile

@@ -0,0 +1,7 @@
+from pkg_resources import get_distribution, DistributionNotFound
+
+try:
+    __version__ = get_distribution("django-newsletter").version
+except DistributionNotFound:
+    # package is not installed
+    __version__ = None

Pipfile.lock

@@ -2,7 +2,7 @@
 
 from django.contrib.admin.utils import unquote
 from django.http import Http404
-from django.utils.encoding import force_text
+from django.utils.encoding import force_str
 from django.utils.translation import gettext as _
 from .models import Subscription
 
@@ -25,8 +25,8 @@ def _getobj(self, request, object_id):
                         '%(name)s object with primary key '
                         '\'%(key)s\' does not exist.'
                     ) % {
-                        'name': force_text(opts.verbose_name),
-                        'key': force_text(object_id)
+                        'name': force_str(opts.verbose_name),
+                        'key': force_str(object_id)
                     }
                 )
 

README.rst

@@ -30,29 +30,26 @@
     warnings.warn('Could not read README.rst and/or CHANGES.rst')
     README = None
 
-try:
-    REQUIREMENTS = open('requirements.txt').read()
-except:
-    warnings.warn('Could not read requirements.txt')
-    REQUIREMENTS = None
-
-try:
-    TEST_REQUIREMENTS = open('requirements_test.txt').read()
-except:
-    warnings.warn('Could not read requirements_test.txt')
-    TEST_REQUIREMENTS = None
 
 setup(
     name='django-newsletter',
-    version="1.0b1",
+    use_scm_version={"version_scheme": "post-release"},
+    setup_requires=["setuptools_scm"],
     description=(
         'Django app for managing multiple mass-mailing lists with both '
         'plaintext as well as HTML templates (and pluggable WYSIWYG editors '
         'for messages), images and a smart queueing system all right from '
         'the admin interface.'
     ),
     long_description=README,
-    install_requires=REQUIREMENTS,
+    install_requires=[
+        "Django>=2.2.16",
+        "python-card-me<1.0",
+        "ldif3<3.2",
+        "chardet",
+        "unicodecsv<0.15",
+        "Pillow",
+    ],
     author='Mathijs de Bruin',
     author_email='mathijs@mathijsfietst.nl',
     url='http://github.com/jazzband/django-newsletter/',
@@ -66,12 +63,11 @@
         'License :: OSI Approved :: GNU Affero General Public License v3',
         'Operating System :: OS Independent',
         'Programming Language :: Python',
-        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3',
         'Programming Language :: Python :: 3.6',
         'Programming Language :: Python :: 3.7',
         'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
         'Topic :: Utilities'
     ],
-    test_suite='runtests.run_tests',
-    tests_require=TEST_REQUIREMENTS
 )

docs/conf.py

@@ -13,8 +13,6 @@
 from newsletter.admin_utils import make_subscription
 from newsletter.models import Message, Newsletter, Submission, Subscription, Attachment, attachment_upload_to
 
-from .utils import AssertLogsMixin
-
 test_files_dir = os.path.join(os.path.dirname(__file__), 'files')
 
 
@@ -42,7 +40,7 @@ def setUp(self):
                                                     message=self.message_with_attachment)
 
 
-class AdminTestCase(AdminTestMixin, AssertLogsMixin, TestCase):
+class AdminTestCase(AdminTestMixin, TestCase):
     def admin_import_file(self, source_file, ignore_errors=''):
         """ Upload an address file for import to admin. """
 

newsletter/__init__.py

@@ -9,7 +9,7 @@
 from django.core import mail
 from django.contrib.auth import get_user_model
 from django.utils import timezone
-from django.utils.encoding import force_text
+from django.utils.encoding import force_str
 from django.test.utils import override_settings
 from django.urls import reverse
 
@@ -458,7 +458,7 @@ def test_unsubscribe_not_subscribed_view(self):
 
         self.assertIn(
             'You are not subscribed to',
-            force_text(list(response.context['messages'])[0])
+            force_str(list(response.context['messages'])[0])
         )
 
     def test_unsubscribe_post(self):

newsletter/admin_utils.py

@@ -12,69 +12,11 @@
 
 from django.test import TestCase
 
-
 from django.template import loader, TemplateDoesNotExist
 
 from django_webtest import WebTest
 
 
-class AssertLogsMixin:
-    """Mixin to enable assertLogs method in Python 2.7.
-
-        patch_logger has similar functionality for Python 2.7, but is
-        removed in Django 3.0. This mixin reworks patch_logger so that
-        the assertLogs method can be used for any supported Django
-        version.
-    """
-    # TODO: Remove use of mixin when Django 1.11 support dropped
-    def assertLogs(self, logger=None, level=None):
-        # Use assertLogs context manager if present
-        try:
-            from unittest.case import _AssertLogsContext
-
-            return _AssertLogsContext(self, logger, level)
-        except ImportError:
-            # Fallback if Django version does not support assertLogs
-            import logging
-            from django.test.utils import patch_logger
-
-            class PatchLoggerResponse:
-                """Object to mimic AssertLogsContext response."""
-                def __init__(self, messages):
-                    self.output = messages
-
-            @contextmanager
-            def patch_logger(logger_name, log_level, log_kwargs=False):
-                """Replicating patch_logger functionality from Django 1.11.
-
-                    Cannot use original Django patch_logger because of how
-                    it returns its response. Have copied and modified it
-                    to return an object that mimics the assertLogs response.
-                """
-                logger_response = PatchLoggerResponse([])
-
-                def replacement(msg, *args, **kwargs):
-                    call = msg % args
-                    logger_response.output.append((call, kwargs) if log_kwargs else call)
-
-                logger = logging.getLogger(logger_name)
-                orig = getattr(logger, log_level)
-                setattr(logger, log_level, replacement)
-
-                try:
-                    yield logger_response
-                finally:
-                    setattr(logger, log_level, orig)
-
-                    if len(logger_response.output) == 0:
-                        raise self.failureException(
-                            "no logs of level {} or higher triggered on {}".format(
-                                log_level, logger_name
-                            )
-                        )
-
-            return patch_logger(logger, level.lower())
-
 class WebTestCase(WebTest):
     def setUp(self):
         self.site = Site.objects.get_current()
@@ -98,7 +40,7 @@ def assertInContext(self, response, variable,
             self.assertEqual(instance, value)
 
 
-class MailTestCase(AssertLogsMixin, TestCase):
+class MailTestCase(TestCase):
     def get_email_list(self, email):
         if email:
             return (email,)
@@ -160,7 +102,7 @@ def assertEmailHasHeader(self, header, content=None, email=None):
                 self.assertEqual(my_email.extra_headers[header], content)
 
 
-class UserTestCase(AssertLogsMixin, TestCase):
+class UserTestCase(TestCase):
     def setUp(self):
         super().setUp()
 
@@ -185,7 +127,7 @@ def tearDown(self):
         self.user.delete()
 
 
-class ComparingTestCase(AssertLogsMixin, TestCase):
+class ComparingTestCase(TestCase):
     def assertLessThan(self, value1, value2):
         self.assertTrue(value1 < value2)
 

requirements.txt

@@ -0,0 +1,44 @@
+[tox]
+envlist =
+    py{36,37,38,39}-dj{22,30,31}
+    py{38,39}-djmain
+
+[testenv]
+deps =
+    coverage
+    django-imperavi
+    # TinyMCE above 3 doesn't support Python 3.5 anymore.
+    # TODO: Remove version freeze when Django 2.2 LTS support is dropped, early 2022.
+    django-tinymce<3
+    pytz
+    webtest
+    django-webtest
+    mock
+    dj22: Django>=2.2,<3.0
+    dj30: Django>=3.0,<3.1
+    dj31: Django>=3.1,<3.2
+    djmain: https://github.com/django/django/archive/main.tar.gz
+usedevelop = True
+ignore_outcome =
+    djmain: True
+commands =
+    coverage run {envbindir}/django-admin test
+    coverage report
+    coverage xml
+setenv =
+    DJANGO_SETTINGS_MODULE=test_project.settings
+    PYTHONPATH={toxinidir}/test_project
+
+[gh-actions]
+python =
+    3.6: py36
+    3.7: py37
+    3.8: py38
+    3.9: py39
+
+[gh-actions:env]
+DJANGO =
+    2.2: dj22
+    3.0: dj30
+    3.1: dj31
+    main: djmain