Skip to content

Commit

Permalink
Cleanup for v3.0.1 release
Browse files Browse the repository at this point in the history
  • Loading branch information
mlaferrera committed Jul 27, 2020
1 parent a09ed6b commit 6763957
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 4 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -65,4 +66,4 @@ target/

# Editors
.idea/
.vscode/
.vscode/
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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?**

Expand Down

0 comments on commit 6763957

Please sign in to comment.