Skip to content

Commit d3fca56

Browse files
authored
Merge pull request #14 from rgs258/release/0.0.5
Changes for 0.0.5 release - setuptools_scm, README updates.
2 parents 7b1f101 + 45a1933 commit d3fca56

File tree

5 files changed

+24
-71
lines changed

5 files changed

+24
-71
lines changed

AUTHORS.rst

-11
This file was deleted.

CHANGELOG.rst

-28
This file was deleted.

MANIFEST.in

-5
This file was deleted.

README.rst

+21-23
Original file line numberDiff line numberDiff line change
@@ -19,25 +19,6 @@ This package aims to make it easy to serve .md files on Django sites.
1919
.. note::
2020
* This package needs tests, and to have Travis and Coveralls properly configured.
2121

22-
Requirements
23-
------------
24-
25-
Tested with:
26-
27-
**The Tested With section describes aspirational goals.**
28-
29-
* Python: 3.5, 3.6, 3.7, 3.8
30-
* Django: 2.2, 3.0
31-
32-
33-
.. note::
34-
* Django 2.2 requires SQLite 3.8.3
35-
* Django 2.2 supports Python 3.5, 3.6, and 3.7.
36-
* Django 3.0 supports Python 3.6, 3.7 and 3.8.
37-
38-
We highly recommend and only officially support the latest release of each series.
39-
40-
4122
Installation
4223
------------
4324

@@ -80,9 +61,9 @@ from ``markdown_view.views`` to serve a .md file
8061
StaffMarkdownView.as_view(file_name='my_app/README.md'),
8162
name="readme"),
8263
83-
8464
Settings
8565
~~~~~~~~
66+
8667
All settings are optional. See `<markdown_view/constants.py>`_ for the defaults.
8768

8869
* `MARKDOWN_VIEW_BASE_DIR` and `BASE_DIR`
@@ -183,13 +164,18 @@ Implementation
183164

184165
At a high level, `MarkdownView` will:
185166

186-
#. Use a template loader to locate .md given as `file_name`
167+
#. Use a template loader to locate `.md` given as `file_name`
187168

188-
#. Render as a template, the contents of the .md file prepended with
189-
`{{% load static %}}`, into several context variables
169+
#. Render as a template, the contents of the `.md` file prepended with
170+
`{% load static %}`, into several context variables
190171

191172
#. Serve the `MARKDOWN_VIEW_TEMPLATE` with the context variables
192173

174+
Release Notes and Contributors
175+
------------------------------
176+
177+
* `Release notes <https://github.com/rgs258/django-markdown-view/releases>`_
178+
* `Our wonderful contributors <https://github.com/rgs258/django-markdown-view/graphs/contributors>`_
193179

194180
Contributing
195181
------------
@@ -204,3 +190,15 @@ We use `Travis`_ coupled with `Coveralls`_ as continious integration tools.
204190
.. _`pull requests`: https://github.com/rgs258/django-markdown-view/pulls
205191
.. _Travis: https://travis-ci.org/github/rgs258/django-markdown-view
206192
.. _Coveralls: https://coveralls.io/github/rgs258/django-markdown-view
193+
194+
Requirements
195+
------------
196+
197+
We aspire to support the currently supported versions of Django.
198+
199+
**The Tested With section describes aspirational goals.**
200+
201+
Tested with:
202+
203+
* Python: 3.6, 3.7, 3.8, 3.9, 3.10
204+
* Django: 2.2, 3.2, 4.0

setup.py

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
11
from setuptools import setup, find_packages
22

33

4-
long_desc = open('README.rst', 'rb').read().decode('utf-8') + '\n\n' + \
5-
open('AUTHORS.rst', 'rb').read().decode('utf-8') + '\n\n' + \
6-
open('CHANGELOG.rst', 'rb').read().decode('utf-8')
4+
long_desc = open('README.rst', 'rb').read().decode('utf-8')
75

86
setup(
97
name='django-markdown-view',
10-
version='0.0.5',
118
description='Serve .md pages as Django views.',
129
long_description=long_desc,
1310
author='Ryan J. Sullivan',
@@ -24,6 +21,8 @@
2421
],
2522
keywords=['django', 'markdown', 'markdown view', 'md'],
2623
include_package_data=True,
24+
setup_requires=["setuptools_scm"],
25+
use_scm_version=True,
2726
classifiers=[
2827
'Development Status :: 3 - Alpha',
2928
'Framework :: Django :: 2',

0 commit comments

Comments
 (0)