Moved project management files into own folder

project_management/generate_api_docs.py

@@ -0,0 +1,128 @@
+#!/usr/bin/env python3
+#-*- coding: utf-8 -*-
+
+from sys import path
+from os.path import dirname
+
+path.insert(0, dirname(path[0]))
+
+from subprocess import run
+from typing import Union
+from frontend.api import (DataSource, NotificationServiceNotFound,
+                          ReminderNotFound, TemplateNotFound, api_docs)
+from MIND import _folder_path, api_prefix
+
+url_var_map = {
+	'int:n_id': NotificationServiceNotFound,
+	'int:r_id': ReminderNotFound,
+	'int:t_id': TemplateNotFound,
+	'int:s_id': ReminderNotFound
+}
+
+result = f"""# API
+Below is the API documentation. Report an issue on [GitHub](https://github.com/Casvt/MIND/issues).
+
+All endpoints have the `{api_prefix}` prefix. That means, for example, that `/auth/login` can be reached at `{api_prefix}/auth/login`.
+
+## Authentication
+
+Authentication is done using an API key. To log in, make a POST request to the [`/api/auth/login`](#authlogin) endpoint. You'll receive an API key, which you can then use in your requests to authenticate. Supply it as a url parameter with the key `api_key`. This API key is valid for one hour, after which the key expires, any further requests return 401 'APIKeyExpired' and you are required to log in again. If no `api_key` is supplied or it is invalid, 401 `APIKeyInvalid` is returned.
+
+For example:
+```bash
+curl -sSL 'http://192.168.2.15:8080/api/reminders?api_key=ABCDEFG'
+```
+
+## Supplying data
+
+Often, data needs to be supplied with a request. If the parameters need to be supplied via `url`, add them to the url as url parameters. If the parameters need to be supplied via `body`, add them to the body as a json object and supply the `Content-Type: application/json` header.
+
+For example:
+```bash
+# URL parameter
+curl -sSL 'http://192.168.2.15:8080/api/reminders/search?api_key=ABCDEFG&query=Fountain&sort_by=time_reversed'
+
+# Body parameter
+curl -sSLX POST \\
+	-H 'Content-Type: application/json' \\
+	-d '{{"title": "Test service", "url": "test://fake/url"}}' \\
+	'http://192.168.2.15:8080/api/notificationservices?api_key=ABCDEFG'
+```
+
+## Endpoints
+The following is automatically generated. Please report any issues on [GitHub](https://github.com/Casvt/MIND/issues).
+"""
+
+for rule, data in api_docs.items():
+	result += f"""### `{rule}`
+
+| Requires being logged in | Description |
+| ------------------------ | ----------- |
+| {'Yes' if data['requires_auth'] else 'No'} | {data['description']} | 
+"""
+
+	url_var = rule.replace('<', '>').split('>')
+	url_var: Union[str, None] = None if len(url_var) == 1 else url_var[1]
+
+	if url_var:
+		result += f"""
+Replace `<{url_var}>` with the ID of the entry. For example: `{rule.replace(f'<{url_var}>', '2')}`.
+"""
+
+	for method in data['methods']:
+		result += f"\n??? {method}\n"
+
+		if method in data['method_descriptions']:
+			result += f"\n	{data['method_descriptions'][method]}\n"
+
+		var_types = {
+			'url': list(var for var in data['input_variables'].get(method, []) if var.source == DataSource.VALUES),
+			'body': list(var for var in data['input_variables'].get(method, []) if var.source == DataSource.DATA)
+		}
+		
+		for var_type, entries in var_types.items():
+			if entries:
+				entries = [e('') for e in entries]
+				result += f"""
+	**Parameters ({var_type})**
+
+	| Name | Required | Description | Allowed values |
+	| ---- | -------- | ----------- | -------------- |
+"""
+				for entry in entries:
+					result += f"	{entry}\n"
+		
+		result += f"""
+	**Returns**
+	
+	| Code | Error | Description |
+	| ---- | ----- | ----------- |
+	| {201 if method == 'POST' else 200}| N/A | Success |
+"""
+
+		url_exception = [url_var_map[url_var]] if url_var in url_var_map else []
+		variable_exceptions = [e for v in data['input_variables'].get(method, []) for e in v.related_exceptions]
+		related_exceptions = sorted(
+			(e() for e in set(variable_exceptions + url_exception)),
+			key=lambda e: (e.api_response['code'], e.api_response['error'])
+		)
+		for related_exception in related_exceptions:
+			ar = related_exception.api_response
+			result += f"	| {ar['code']} | {ar['error']} | {related_exception.__doc__} |\n"
+
+	result += '\n'
+
+with open(_folder_path('docs', 'api.md'), 'r') as f:
+	current_content = f.read()
+
+if current_content == result:
+	print('Nothing changed')
+else:
+	with open(_folder_path('docs', 'api.md'), 'w+') as f:
+		f.write(result)
+	
+	run(["git", "checkout", "Development"])
+	run(["git", "add", _folder_path('docs', 'api.md')])
+	run(["git", "commit", "-m", "Updated API docs"])
+	run(["git", "push"])
+