From 27e39a05d8d2ce17b5f601debe63c5e9de8bb747 Mon Sep 17 00:00:00 2001 From: Athanasius Date: Wed, 18 Jan 2023 11:48:27 +0000 Subject: [PATCH] PLUGINS: Document using `config.user_agent` for User-Agent And, really, just use `timeout_session` anyway, which does this. --- PLUGINS.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/PLUGINS.md b/PLUGINS.md index b0626cfb..3048f345 100644 --- a/PLUGINS.md +++ b/PLUGINS.md @@ -126,8 +126,11 @@ Live galaxy. Note the implementation details of this. At time of writing it performs a `semantic_version` >= check. `import timeout_session` - provides a method called `new_session` that creates -a requests.session with a default timeout on all requests. Recommended to -reduce noise in HTTP requests +a `requests.session` with a default timeout on all requests. Recommended to +reduce noise in HTTP requests. This also ensures your requests use the central +"User-Agent" header value. If you do have reason to make a request otherwise +please ensure you use the `config.user_agent` value as the User-Agent (you can +append a string to call out your plugin if you wish). `from ttkHyperlinkLabel import HyperlinkLabel` and `import myNotebook as nb` - For creating UI elements.