From f596dfe20ff9a962f3bc80f7461902991ccc3010 Mon Sep 17 00:00:00 2001 From: Paul Schilling Date: Tue, 9 May 2023 13:01:50 +0200 Subject: [PATCH] update README and docs --- README.rst | 5 ++++- docs/quickstart.rst | 3 +++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 2ad5883..4dfca82 100644 --- a/README.rst +++ b/README.rst @@ -97,6 +97,9 @@ To use this with your project you need to follow these steps: } LOG_OUTGOING_REQUESTS_DB_SAVE = True # save logs enabled/disabled based on the boolean value + LOG_OUTGOING_REQUESTS_SAVE_BODY = True # save request/response body + LOG_OUTGOING_REQUESTS_LOG_BODY_TO_STDOUT = True # log request/response body to STDOUT + #. Run the migrations @@ -113,7 +116,7 @@ To use this with your project you need to follow these steps: print(res.json()) #. Check stdout for the printable output, and navigate to ``/admin/log_outgoing_requests/outgoingrequestslog/`` to see - the saved log records + the saved log records. The settings for saving logs can by overridden under ``/admin/log_outgoing_requests/outgoingrequestslogconfig/``. Local development diff --git a/docs/quickstart.rst b/docs/quickstart.rst index d1fabcb..70e3301 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -58,6 +58,9 @@ Installation } LOG_OUTGOING_REQUESTS_DB_SAVE = True # save logs enabled/disabled based on the boolean value + LOG_OUTGOING_REQUESTS_SAVE_BODY = True # save request/response body + LOG_OUTGOING_REQUESTS_LOG_BODY_TO_STDOUT = True # log request/response body to STDOUT + #. Run ``python manage.py migrate`` to create the necessary database tables.