Ezq

**Fixed**

- [12]: add `py.typed`

---

**Fixed**

- GitHub CI command to build docs

---

**Fixed**

- `src` file structure

---

[10]: https://github.com/metaist/ezq/issues/10

**Fixed**

- [10]: `multiprocess` dependency

**Removed**

- `setup.py`, `__about__.py`: project metadata now in `pyproject.toml`
- `.pylint`: now using `ruff`
- `__init__.py`: now just `src/ezq.py`

---

[5]: https://github.com/metaist/ezq/issues/5
[7]: https://github.com/metaist/ezq/issues/7
[8]: https://github.com/metaist/ezq/issues/8
[9]: https://github.com/metaist/ezq/issues/9

**Fixed**

- GitHub Action: continuous integration
- [9]: `multiprocessing` on MacOS (by switching to `multiprocess`)

**Changed**

- [8]: order of `Msg` parameters so that `data` comes first
- [9]: core library is now `multiprocess` instead of `multiprocessing`; `dill` replaces `pickle`.

**Added**

- GitHub Action: `mypy` check for examples and tests
- supported python versions badge
- [5]: `Worker` wrapper for `Process` and `Thread`
- `cSpell` to track ignored words

**Removed**

- [7]: deprecated functions: `put_msg`, `iter_msg`, `iter_q`, `sortiter`, `endq`, `endq_and_wait`

---

[1]: https://github.com/metaist/ezq/issues/1
[3]: https://github.com/metaist/ezq/issues/3
[4]: https://github.com/metaist/ezq/issues/4
[6]: https://github.com/metaist/ezq/issues/6

This version introduced a new class-based API via the `Q` object.
The function-based API is officially deprecated and will be removed
in v3.

**Changed**

- `sortiter` now sorts the list of waiting messages in place to improve performance (~50%).
- replaced `pylint` with [`ruff`](https://github.com/charliermarsh/ruff)
- [6]: supported python versions: removed 3.6, 3.7; added 3.10, 3.11

**Added**

- build badge
- [1]: support for `threading`
- [3]: `map` function for simple use-cases
- [4]: `Q` class wrapper for the queue

**Deprecated**

Most of the function-based API is now deprecated.

- `put_msg`: use `Q.put()` instead
- `iter_msg`: use `iter(Q)` instead
- `iter_q`: use `Q.items()` instead
- `sortiter`: use `Q.sorted()` instead
- `endq`: use `Q.end()` instead
- `endq_and_wait`: use `Q.stop()` instead

---