FIX: Fixed an issue caused by pandoc squeezing tables

* Added two arguments to the pandoc call to set the page width at 1000 columns and to disable text wrapping. This fixes an issue where it would generate invalid RST.
* Changed the `use_scm_version` argument in `setup` to point to an absolute directory for VERSION.txt.
* Renamed `LazyReadmyConverter` to `LazyMarkdownConverter`.
* Added an explicit setting for `long_description`'s encoding.
* Changed how README.md is read so it's less cluttered.

Author: rspeed

README.md

@@ -105,32 +105,28 @@ No standards are currently supported across all major browsers, though it's hope
 
 |                                     | Chrome         | Edge                      | Firefox                  | Safari         |
 | ----------------------------------: | :------------- | :------------------------ | :----------------------- | :------------- |
-| **Content Security Policy (CSP)**   | Supported      | Supported ²               | Supported                | Supported ⁴    |
-| **HTTP Public Key Pinning (HPKP)**  | Supported ⁵    | Under Consideration ⁶     | Not Supported ⁷          | Not Supported  |
-| **Out-of-Band Reporting API**       | Planned ⁹      | Not Supported             | Not Supported            | Not Supported  |
-| **Network Error Logging (NEL)**     | Planned ¹³     | Under Consideration ¹⁴    | Not Supported            | Not Supported  |
-| **Expect-CT**                       | Planned ¹⁷     | Planned ¹⁸                | ?                        | ?              |
+| **Content Security Policy (CSP)**   | Supported      | [Supported][2]            | Supported                | [Supported][4] |
+| **HTTP Public Key Pinning (HPKP)**  | [Supported][5] | [Under Consideration][6]  | [Not Supported][7]       | Not Supported  |
+| **Out-of-Band Reporting API**       | [Planned][9]   | Not Supported             | Not Supported            | Not Supported  |
+| **Network Error Logging (NEL)**     | [Planned][13]  | [Under Consideration][14] | Not Supported            | Not Supported  |
+| **Expect-CT**                       | [Planned][17]  | [Planned][18]             | ?                        | ?              |
 | **Expect-Staple**                   | ?              | ?                         | ?                        | ?              |
 
 
-1. Source needed
-2. https://developer.microsoft.com/en-us/microsoft-edge/platform/status/contentsecuritypolicylevel2/
-3. Source needed
-4. https://webkit.org/status/#specification-content-security-policy-level-3
-5. https://www.chromestatus.com/feature/4669935557017600
-6. https://developer.microsoft.com/en-us/microsoft-edge/platform/status/publickeypinningextensionforhttp/
-7. https://bugzilla.mozilla.org/show_bug.cgi?id=1091176
-8. Source needed
-9. https://bugs.chromium.org/p/chromium/issues/detail?id=676016
-10. Source needed
-11. Source needed
-12. Source needed
-13. https://www.chromestatus.com/feature/5391249376804864
-14. https://developer.microsoft.com/en-us/microsoft-edge/platform/status/networkerrorlogging/
-15. Source needed
-16. Source needed
-17. https://bugs.chromium.org/p/chromium/issues/detail?id=679012
-18. https://lists.w3.org/Archives/Public/ietf-http-wg/2016OctDec/0767.html
+[2]: https://developer.microsoft.com/en-us/microsoft-edge/platform/status/contentsecuritypolicylevel2/ "Partial support for Level 3"
+[4]: https://webkit.org/status/#specification-content-security-policy-level-3 "Partial support for Level 3"
+
+[5]: https://www.chromestatus.com/feature/4669935557017600
+[6]: https://developer.microsoft.com/en-us/microsoft-edge/platform/status/publickeypinningextensionforhttp/ "Under Consideration"
+[7]: https://bugzilla.mozilla.org/show_bug.cgi?id=1091176 "No report-uri or report-only support."
+
+[9]: https://bugs.chromium.org/p/chromium/issues/detail?id=676016
+
+[13]: https://www.chromestatus.com/feature/5391249376804864 "No recent progress"
+[14]: https://developer.microsoft.com/en-us/microsoft-edge/platform/status/networkerrorlogging/
+
+[17]: https://bugs.chromium.org/p/chromium/issues/detail?id=679012
+[18]: https://lists.w3.org/Archives/Public/ietf-http-wg/2016OctDec/0767.html
 
 
 ## Tools and Similar Projects

setup.py

@@ -2,19 +2,26 @@
 from setuptools import setup, find_packages
 
 
+# Root directory of the project
+project_dir = path.dirname(__file__)
 
-class LazyReadmeConverter:
-	""" Uses pandoc to convert the README from Markdown to reStructuredText. """
+
+# Dump the contents of README.md into a variable
+with open(path.join(path.abspath(project_dir), 'README.md'), encoding='utf-8') as f:
+	long_description = f.read()
+
+
+
+class LazyMarkdownConverter:
+	""" Lazily converts README from Markdown to reStructuredText using pandoc. """
 
 	IN_FORMAT = 'markdown_github'
 	OUT_FORMAT = 'rst'
-	converted = False
 
 
-	def __init__(self, file_path):
-		# Read the entire file contents into a string
-		with open(file_path, encoding='utf-8') as f:
-			self.value = f.read()
+	def __init__(self, value):
+		self.value = value
+		self.converted = False
 
 
 	def __str__(self):
@@ -23,7 +30,12 @@ def __str__(self):
 		if not self.converted:
 			try:
 				from pypandoc import convert_text
-				self.value = convert_text(self.value, self.OUT_FORMAT, self.IN_FORMAT)
+				self.value = convert_text(
+					self.value,
+					self.OUT_FORMAT,
+					self.IN_FORMAT,
+					extra_args=['--columns=1000', '--wrap=none']
+				)
 			except ImportError:
 				print("pypandoc isn't installed")
 			except OSError:
@@ -51,10 +63,11 @@ def __repr__(self):
 setup(
 	name='Django-Lookout',
 
-	use_scm_version={'write_to': 'lookout/VERSION.txt'},
+	use_scm_version={'write_to': path.join(project_dir, 'lookout', 'VERSION.txt')},
 
 	description='API endpoint for receiving incident reports from Content Security Policy (CSP), HTTP Public Key Pinning (HPKP), and the HTTP Reporting API.',
-	long_description=LazyReadmeConverter(path.join(path.abspath(path.dirname(__file__)), 'README.md')),
+	long_description=LazyMarkdownConverter(long_description),
+	long_description_content_type='UTF-8',
 
 	url='https://github.com/rspeed/Django-Lookout',