Add TOC to README

Author: RadoRado

README.md

@@ -9,6 +9,33 @@
 
 ---
 
+**Table of contents:**
+
+<!-- toc -->
+
+- [General API Stuff](#general-api-stuff)
+  * [CORS](#cors)
+- [Authentication - JWT](#authentication---jwt)
+  * [Settings](#settings)
+  * [APIs](#apis)
+  * [Requiring authentication](#requiring-authentication)
+- [Authentication - Sessions](#authentication---sessions)
+  * [DRF & Overriding `SessionAuthentication`](#drf--overriding-sessionauthentication)
+  * [Cross origin](#cross-origin)
+  * [APIs](#apis-1)
+  * [`HTTP Only` / `SameSite`](#http-only--samesite)
+  * [Reading list](#reading-list)
+- [Example List API](#example-list-api)
+- [Helpful commands for local development without docker-compose](#helpful-commands-for-local-development-without-docker-compose)
+- [Helpful commands for local development with docker-compose](#helpful-commands-for-local-development-with-docker-compose)
+- [Deployment](#deployment)
+  * [Heroku](#heroku)
+  * [AWS ECS](#aws-ecs)
+
+<!-- tocstop -->
+
+---
+
 This project serves as an [example of our styleguide](https://github.com/HackSoftware/Django-Styleguide)
 
 The structure is inspired by [cookiecutter-django](https://github.com/pydanny/cookiecutter-django) and modified based on our experience with Django.

markdown_tools/toc.py

@@ -0,0 +1,44 @@
+import re
+from subprocess import check_output
+
+
+def get_new_toc():
+    new_toc = check_output(
+        'markdown-toc README.md',
+        shell=True
+    ).decode('utf-8')
+
+    pattern = ['<!-- toc -->', '', new_toc, '', '<!-- tocstop -->']
+
+    return '\n'.join(pattern)
+
+
+def get_readme():
+    with open('README.md', 'r') as f:
+        return f.read()
+
+
+def save_readme(readme):
+    with open('README.md', 'w') as f:
+        return f.write(readme)
+
+
+def replace_toc():
+    readme = get_readme()
+    new_toc = get_new_toc()
+
+    regex = '<!-- toc -->(.|\n)+<!-- tocstop -->'
+
+    new_readme = re.sub(regex, new_toc, readme)
+
+    save_readme(new_readme)
+
+    print('TOC updated ...')
+
+
+def main():
+    return replace_toc()
+
+
+if __name__ == '__main__':
+    main()