Merge branch 'develop' into 'master'.

urda · Apr 22, 2018 · ab4edc8 · ab4edc8
2 parents 8eec687 + e022084
commit ab4edc8
Show file tree

Hide file tree

Showing 13 changed files with 96 additions and 89 deletions.
diff --git a/.github/codecov.yml b/.github/codecov.yml
@@ -0,0 +1,6 @@
+coverage:
+  status:
+    patch:
+      default:
+        enabled: yes
+        target: 100%
diff --git a/.travis.yml b/.travis.yml
@@ -10,15 +10,12 @@ python:
   - 3.6
 
 env:
-  - DJANGO_VERSION=1.8.18 DATABASE_ENGINE=mysql
-  - DJANGO_VERSION=1.8.18 DATABASE_ENGINE=postgres
-  - DJANGO_VERSION=1.8.18 DATABASE_ENGINE=sqlite
-  - DJANGO_VERSION=1.11.8 DATABASE_ENGINE=mysql
-  - DJANGO_VERSION=1.11.8 DATABASE_ENGINE=postgres
-  - DJANGO_VERSION=1.11.8 DATABASE_ENGINE=sqlite
-  - DJANGO_VERSION=2.0 DATABASE_ENGINE=mysql
-  - DJANGO_VERSION=2.0 DATABASE_ENGINE=postgres
-  - DJANGO_VERSION=2.0 DATABASE_ENGINE=sqlite
+  - DJANGO_VERSION=1.11.12 DATABASE_ENGINE=mysql
+  - DJANGO_VERSION=1.11.12 DATABASE_ENGINE=postgres
+  - DJANGO_VERSION=1.11.12 DATABASE_ENGINE=sqlite
+  - DJANGO_VERSION=2.0.4 DATABASE_ENGINE=mysql
+  - DJANGO_VERSION=2.0.4 DATABASE_ENGINE=postgres
+  - DJANGO_VERSION=2.0.4 DATABASE_ENGINE=sqlite
 
 branches:
   only:

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,26 @@
 # django-letsencrypt CHANGELOG
 
+## v3.0.1
+
+- Breaking Changes
+  - `Django 1.8` support has been dropped. `v3.0.0` is the last supported
+    version for users still on `Django 1.8`.
+- Documentation Changes
+  - Update the `ACME challenge` link in `README.rst`.
+- Project Changes
+  - Disable `universal` wheel creation in `setup.cfg`.
+  - Add a `python_requires` entry into `setup.py`.
+    - You can learn more about this feature by reading
+    [this](https://packaging.python.org/tutorials/distributing-packages/#python-requires)
+    document.
+  - Bumped to the latest `pytz`, version `2018.4`.
+  - Switched from `reStructuredText` to `Markdown`.
+- Internal Changes
+  - Bumped `DJANGO_VERSION` targets in `.travis.yml`.
+- Thanks to Contributors:
+  - [michael-k](https://github.com/michael-k)
+  - [Paolo Dina](https://github.com/paolodina)
+
 ## v3.0.0
 
 - New Features

diff --git a/LICENSE b/LICENSE
@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2016-2017 Peter Urda
+   Copyright 2016-2018 Peter Urda
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,4 +1,4 @@
 include CHANGELOG.md
 include LICENSE
-include README.rst
+include README.md
 recursive-include letsencrypt/migrations *.py
diff --git a/README.md b/README.md
@@ -0,0 +1,44 @@
+# Let's Encrypt App for Django
+
+[![Travis Build Status (Master)](https://travis-ci.org/urda/django-letsencrypt.svg?branch=master)](https://travis-ci.org/urda/django-letsencrypt) [![Codecov Status (Master)](https://codecov.io/gh/urda/django-letsencrypt/branch/master/graph/badge.svg)](https://codecov.io/gh/urda/django-letsencrypt/branch/master)
+
+`django-letsencrypt` will allow you to add, remove, and update any
+[ACME challenge](https://github.com/ietf-wg-acme/acme/) objects you may
+need through your Django admin interface. Simply add the `ACME challenge`
+and `response` for your app to serve up the necessary information for
+[Let's Encrypt](https://letsencrypt.org/how-it-works/) validation.
+
+## Installation & Configuration
+
+1. `pip install django-letsencrypt`
+
+2. Add `letsencrypt` to your `INSTALLED_APPS`
+
+```python
+INSTALLED_APPS = [
+   ... ,
+   'letsencrypt',
+   ... ,
+]
+```
+
+3. Include the `letsencrypt` in your project's `urls.py`,
+   or where applicable (usually your root `urls.py`).
+
+```python
+url(r'^\.well-known/', include('letsencrypt.urls'))
+```
+
+4. Run `manage.py migrate` to create the required table for the
+   `letsencrypt` model
+
+5. Create your `ACME Challenge` objects in your Django admin interface
+
+6. Test your `ACME Challenge` objects and their responses by visiting
+   them:
+
+```
+{Django Site}/.well-known/acme-challenge/challenge_text
+```
+
+7. Enjoy your easy to manage `ACME Challenges` inside your Django project!
diff --git a/README.rst b/README.rst
diff --git a/example_project/requirements.txt b/example_project/requirements.txt
@@ -1,2 +1,2 @@
-Django==1.11.7
-pytz==2017.3
+Django==2.0.4
+pytz==2018.4
diff --git a/letsencrypt/__init__.py b/letsencrypt/__init__.py
@@ -14,6 +14,6 @@
 limitations under the License.
 """
 
-__version__ = '3.0.0'
+__version__ = '3.0.1'
 
 default_app_config = 'letsencrypt.apps.LetsEncryptConfig'
diff --git a/letsencrypt/models.py b/letsencrypt/models.py
@@ -1,5 +1,5 @@
 """
-Copyright 2016-2017 Peter Urda
+Copyright 2016-2018 Peter Urda
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -15,20 +15,10 @@
 """
 
 from django.db import models
-
-try:
-    from django.urls import (
-        reverse,
-        NoReverseMatch,
-    )
-except ImportError:
-    # Django versions prior to 2.0 use the following:
-
-    # noinspection PyUnresolvedReferences
-    from django.core.urlresolvers import (
-        reverse,
-        NoReverseMatch,
-    )
+from django.urls import (
+    reverse,
+    NoReverseMatch,
+)
 
 
 class AcmeChallenge(models.Model):

diff --git a/setup.cfg b/setup.cfg
@@ -2,4 +2,4 @@
 # This flag says that the code is written to work on both Python 2 and Python
 # 3. If at all possible, it is good practice to do this. If you cannot, you
 # will need to generate wheels for each Python version that you support.
-universal=1
+universal=0
diff --git a/setup.py b/setup.py
@@ -1,5 +1,5 @@
 """
-Copyright 2016-2017 Peter Urda
+Copyright 2016-2018 Peter Urda
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -17,31 +17,32 @@
 import os
 from setuptools import setup
 
-with open(os.path.join(os.path.dirname(__file__), 'README.rst')) as readme:
+with open(os.path.join(os.path.dirname(__file__), 'README.md')) as readme:
     README = readme.read()
 
 os.chdir(os.path.normpath(os.path.join(os.path.abspath(__file__), os.pardir)))
 
 setup(
     name='django-letsencrypt',
-    version='3.0.0',
+    version='3.0.1',
+    python_requires=">=3.4, <4",
     packages=['letsencrypt'],
     include_package_data=True,
     license='Apache License, Version 2.0',
     description="A simple Django app to handle Let's Encrypt ACME challenges.",
     long_description=README,
+    long_description_content_type='text/markdown',
     url='https://github.com/urda/django-letsencrypt',
     author='Peter Urda',
-    author_email='noreply@urda.cc',
+    author_email='noreply@urda.com',
     install_requires=[
-        "Django>=1.8.18,!=1.9.*,!=1.10.*",
-        "pytz>=2017.3",
+        "Django>=1.11",
+        "pytz>=2018.4",
     ],
     classifiers=[
         'Development Status :: 5 - Production/Stable',
         'Environment :: Web Environment',
         'Framework :: Django',
-        'Framework :: Django :: 1.8',
         'Framework :: Django :: 1.11',
         'Framework :: Django :: 2.0',
         'Intended Audience :: Developers',

diff --git a/tox.ini b/tox.ini
@@ -1,7 +1,6 @@
 [tox]
 envlist =
     flake-and-version-check
-    py{34,35,36}-django18
     py{34,35,36}-django111
     py{34,35,36}-django20
     coverage-report
@@ -12,7 +11,6 @@ commands =
     make test-tox
 
 deps =
-    django18: Django>=1.8,<1.9
     django111: Django>=1.11,<2.0
     django20: Django>=2.0,<2.1
     pytz