From 6763957302e34228821b05463ad2e4b37e092317 Mon Sep 17 00:00:00 2001 From: Marcus LaFerrera Date: Mon, 27 Jul 2020 13:06:18 -0400 Subject: [PATCH] Cleanup for v3.0.1 release --- .gitignore | 3 ++- CHANGELOG.md | 3 ++- docs/faq.rst | 4 ++-- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/.gitignore b/.gitignore index 2ea4af2..c390bfa 100644 --- a/.gitignore +++ b/.gitignore @@ -32,6 +32,7 @@ var/ # before PyInstaller builds the exe, so as to inject date/other infos into it. *.manifest *.spec +.python-version # Installer logs pip-log.txt @@ -65,4 +66,4 @@ target/ # Editors .idea/ -.vscode/ \ No newline at end of file +.vscode/ diff --git a/CHANGELOG.md b/CHANGELOG.md index 734939b..4a348bc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [Unreleased] +## [3.0.1] - 2020-07-27 ### Added @@ -18,6 +18,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 arguments that contain `=` or `:` characters - Ensure `always_dispatch` in `stoq.cfg` leverages `getlist()` when `Stoq()` is is instantiated. (#149) +- Multiple fixes and updates to Dockerfile ## [3.0.0] - 2020-03-18 diff --git a/docs/faq.rst b/docs/faq.rst index 3e80a0e..4109fc9 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -46,11 +46,11 @@ Frequently Asked Questions - **stoQ seems slow when decoding json, can this be improved?** - Possibly. stoQ leverages BeautifulSoup's UnicodeDammit function to serialize bytes into proper json serializable content. In order to limit the python library requirements and maximize compatibility, we purposefully limit core dependencies. BeautifulSoup by default attempts to leverage the python library `cchardet`, which is much more efficient than the default python library that BeautifulSoup falls back to `chardet`. Simply install `cchardet` via pip, and you may see a nice performance boost if you have complex results with bytes. + Possibly. stoQ leverages BeautifulSoup's UnicodeDammit function to serialize bytes into proper json serializable content. In order to limit the python library requirements and maximize compatibility, we purposefully limit core dependencies. BeautifulSoup by default attempts to leverage the python library `cchardet`, which is much more efficient than the default python library that BeautifulSoup falls back to `chardet`. Simply install `cchardet` via pip, and you may see a nice performance boost if you have complex results with bytes. - **I know stoQ supports async operations, but my plugins don't seem to be completing any faster!** - While all current stoQ plugins support the latest version of stoQ, not all of them will run asynchronously. There are several reasons for this. Some depend on 3rd party libraries that are not asyncio compatiable. For these, we will keep an eye out for updated 3rd party libraries that support asyncio. For many others, it is simply a matter of competing priorities. We, and very gratefully, several contributors to stoQ have been updating plugins for full asyncio support, it is still a time consuming process. If you would like to help in this effort, please do! We are more than happy to accept all of the help you are willing to volunteer. + While all current stoQ plugins support the latest version of stoQ, not all of them will run asynchronously. There are several reasons for this. Some depend on 3rd party libraries that are not asyncio compatiable. For these, we will keep an eye out for updated 3rd party libraries that support asyncio. For many others, it is simply a matter of competing priorities. We, and very gratefully, several contributors to stoQ have been updating plugins for full asyncio support, it is still a time consuming process. If you would like to help in this effort, please do! We are more than happy to accept all of the help you are willing to volunteer. - **Do you plan on maintaining this project long term?**