Merge pull request #14 from rgs258/release/0.0.5

Changes for 0.0.5 release - setuptools_scm, README updates.
rgs258 · Mar 31, 2022 · d3fca56 · d3fca56
2 parents 7b1f101 + 45a1933
commit d3fca56
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 71 deletions.
diff --git a/AUTHORS.rst b/AUTHORS.rst
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
diff --git a/MANIFEST.in b/MANIFEST.in
diff --git a/README.rst b/README.rst
@@ -19,25 +19,6 @@ This package aims to make it easy to serve .md files on Django sites.
 .. note::
     * This package needs tests, and to have Travis and Coveralls properly configured.
 
-Requirements
-------------
-
-Tested with:
-
-**The Tested With section describes aspirational goals.**
-
-* Python: 3.5, 3.6, 3.7, 3.8
-* Django: 2.2, 3.0
-
-
-.. note::
-    * Django 2.2 requires SQLite 3.8.3
-    * Django 2.2 supports Python 3.5, 3.6, and 3.7.
-    * Django 3.0 supports Python 3.6, 3.7 and 3.8.
-
-    We highly recommend and only officially support the latest release of each series.
-
-
 Installation
 ------------
 
@@ -80,9 +61,9 @@ from ``markdown_view.views`` to serve a .md file
         StaffMarkdownView.as_view(file_name='my_app/README.md'),
         name="readme"),
 
-
 Settings
 ~~~~~~~~
+
 All settings are optional. See `<markdown_view/constants.py>`_ for the defaults.
 
 * `MARKDOWN_VIEW_BASE_DIR` and `BASE_DIR`
@@ -183,13 +164,18 @@ Implementation
 
 At a high level, `MarkdownView` will:
 
-#. Use a template loader to locate .md given as `file_name`
+#. Use a template loader to locate `.md` given as `file_name`
 
-#. Render as a template, the contents of the .md file prepended with
-   `{{% load static %}}`, into several context variables
+#. Render as a template, the contents of the `.md` file prepended with
+   `{% load static %}`, into several context variables
 
 #. Serve the `MARKDOWN_VIEW_TEMPLATE` with the context variables
 
+Release Notes and Contributors
+------------------------------
+
+* `Release notes <https://github.com/rgs258/django-markdown-view/releases>`_
+* `Our wonderful contributors <https://github.com/rgs258/django-markdown-view/graphs/contributors>`_
 
 Contributing
 ------------
@@ -204,3 +190,15 @@ We use `Travis`_ coupled with `Coveralls`_ as continious integration tools.
 .. _`pull requests`: https://github.com/rgs258/django-markdown-view/pulls
 .. _Travis: https://travis-ci.org/github/rgs258/django-markdown-view
 .. _Coveralls: https://coveralls.io/github/rgs258/django-markdown-view
+
+Requirements
+------------
+
+We aspire to support the currently supported versions of Django.
+
+**The Tested With section describes aspirational goals.**
+
+Tested with:
+
+* Python: 3.6, 3.7, 3.8, 3.9, 3.10
+* Django: 2.2, 3.2, 4.0
diff --git a/setup.py b/setup.py
@@ -1,13 +1,10 @@
 from setuptools import setup, find_packages
 
 
-long_desc = open('README.rst', 'rb').read().decode('utf-8') + '\n\n' + \
-            open('AUTHORS.rst', 'rb').read().decode('utf-8') + '\n\n' + \
-            open('CHANGELOG.rst', 'rb').read().decode('utf-8')
+long_desc = open('README.rst', 'rb').read().decode('utf-8')
 
 setup(
     name='django-markdown-view',
-    version='0.0.5',
     description='Serve .md pages as Django views.',
     long_description=long_desc,
     author='Ryan J. Sullivan',
@@ -24,6 +21,8 @@
     ],
     keywords=['django', 'markdown', 'markdown view', 'md'],
     include_package_data=True,
+    setup_requires=["setuptools_scm"],
+    use_scm_version=True,
     classifiers=[
         'Development Status :: 3 - Alpha',
         'Framework :: Django :: 2',