Merge pull request #9 from sergeyklay/fix/packaging

Packaging fixes
sergeyklay · May 25, 2021 · 86e0782 · 86e0782
2 parents f0a7802 + c3df6c6
commit 86e0782
Show file tree

Hide file tree

Showing 8 changed files with 43 additions and 6 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -5,6 +5,32 @@ This file contains a brief summary of new features and dependency changes or
 releases, in reverse chronological order.
 
 
+2.0.1 (2021-05-25)
+------------------
+
+Bug Fixes
+^^^^^^^^^
+
+* Fixed changelog URL in package description.
+* Added missed ``test_env.txt`` to the package contents.
+
+
+Improved Documentation
+^^^^^^^^^^^^^^^^^^^^^^
+
+* Improved package documentation.
+* Fixed misspellings in the documentation.
+
+
+Trivial/Internal Changes
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+* Added testing dependencies to ``setup.py``.
+
+
+----
+
+
 2.0.0 (2021-05-25)
 ------------------
 

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -16,6 +16,7 @@ include AUTHORS.rst CHANGELOG.rst CONTRIBUTING.rst LICENSE README.rst SECURITY.r
 # Many OS distributions prefers provide an ability run the tests
 # during the package installation.
 recursive-include tests *.py
+recursive-include tests *.txt
 
 # All files in the sdist with a .pyc, .pyo, or .pyd extension will be removed
 # from the sdist.

diff --git a/README.rst b/README.rst
@@ -117,7 +117,7 @@ and the latest release on `PyPI <https://pypi.org/project/django-environ-2/>`_.
 It’s rigorously tested on Python 3.6+, and officially supports
 Django 1.11, 2.2, 3.0, 3.1 and 3.2.
 
-If you'd like to contribute to Gstore you're most welcome!
+If you'd like to contribute to ``django-environ-2`` you're most welcome!
 
 .. -support-
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -56,6 +56,7 @@ def find_version(meta_file):
     "sphinx.ext.doctest",
     "sphinx.ext.intersphinx",
     "sphinx.ext.todo",
+    "notfound.extension"
 ]
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/environ/__init__.py b/environ/__init__.py
@@ -13,6 +13,7 @@
 
 Modules:
 
+    compat
     environ
 
 Misc variables:
@@ -35,7 +36,7 @@
 
 
 __copyright__ = 'Copyright (C) 2021 Serghei Iakovlev'
-__version__ = '2.0.0'
+__version__ = '2.0.1'
 __license__ = 'MIT'
 __author__ = 'Daniele Faraglia'
 __author_email__ = '[email protected]'

diff --git a/environ/environ.py b/environ/environ.py
@@ -6,9 +6,11 @@
 # For the full copyright and license information, please view
 # the LICENSE file that was distributed with this source code.
 
-"""
+"""Configure Django made easy.
+
 django-environ-2 allows you to utilize 12factor inspired environment
 variables to configure your Django application.
+
 """
 
 import ast

diff --git a/setup.py b/setup.py
@@ -52,7 +52,7 @@ def changes():
             '===================\n',
             changes(),
             '',
-            f"`Full changelog <{find_meta('url')}/en/latest/changelog.htm>`_.",
+            f"`Full changelog <{find_meta('url')}/en/latest/changelog.html>`_.",
             '',
             read_file(path.join(PKG_DIR, 'SECURITY.rst')),
             '',
@@ -157,19 +157,24 @@ def get_version_string():
 #
 EXTRAS_REQUIRE = {
     # Dependencies that are required to run tests
-    'testing': [],
+    'testing': [
+        "pytest>=6.2.0",  # Our test framework
+        'pytest-cov>=2.11.1',  # Pytest plugin for measuring coverage
+    ],
     # Dependencies that are required to develop package
     'develop': [],
     # Dependencies that are required to build documentation
     'docs': [
         'furo>=2020.12.30b24,==2020.12.*',  # Sphinx documentation theme
         'sphinx>=3.5.0',  # Python documentation generator
+        "sphinx-notfound-page",  # Create a custom 404 page
     ],
 }
 
 # Project's URLs
 PROJECT_URLS = {
     'Documentation': 'https://django-environ-2.readthedocs.io',
+    "Changelog": f"{find_meta('url')}/en/latest/changelog.html",
     'Bug Tracker': 'https://github.com/sergeyklay/django-environ-2/issues',
     'Source Code': 'https://github.com/sergeyklay/django-environ-2',
 }

diff --git a/tox.ini b/tox.ini
@@ -6,7 +6,7 @@
 # For the full copyright and license information, please view
 # the LICENSE file that was distributed with this source code.
 
-# Tox (http://tox.testrun.org/) - run tests in multiple virtualenvs.
+# Tox (https://tox.readthedocs.io) - run tests in multiple virtualenvs.
 # Also contains configuration settings for all tools executed by Tox.
 
 [tox]
@@ -55,6 +55,7 @@ commands_pre =
 commands = flake8 environ
 
 [testenv:docs]
+description = Build package documentation (HTML)
 # Keep basepython in sync with gh-actions and .readthedocs.yml.
 basepython = python3.8
 extras = docs