Support: Migrating 2.2.0 -> 3.0.0

[numberoverzero]

Migration Guide

Please post any questions or issues you encounter migrating to 3.0.0, especially anything not covered or unclear in the migration guide above.

Some possible issues:

• migrating send(event) -> async send(event)
• migrating trigger(event) -> async trigger(event)
• __event__ added to **kwargs for all handlers
• handle_raw removed (raw_handlers -> message_handlers)
• migrating send_raw(message) -> async send_message(message)
• removal of explicit loop argument

[numberoverzero]

@hell-of-the-devil (or anyone else stumbling on this issue) if you have some time to try things out, I'm about wrapping up with the changes for 3.0.0 and can publish to PyPI by end of week.

I'd love help with either some hands-on testing (A or B, below) or some doc review (C)

A. Install from git hash

Assuming you have python3.12 on your path, this will install bottom in a new venv at ~/bottom-3.0/.venv:

python3.12 -m venv ~/bottom-3.0/.venv &&\
  ~/bottom-3.0/.venv/bin/pip install git+https://github.com/numberoverzero/bottom.git@a3e5d7d5bd0ef409002b3081586b9f4e31d16a9a

B. Install dev environment

If you want to grab the whole development environment (including dev dependencies) and poke around, this will set up the same directory, with the source in ~/bottom-3.0:

git clone [email protected]:numberoverzero/bottom.git ~/bottom-3.0 &&\
  pushd ~/bottom-3.0 &&\
  git checkout a3e5d7d5bd0ef409002b3081586b9f4e31d16a9a && make dev &&\
  popd

In either case, you can then check the version with:

~/bottom-3.0/.venv/bin/python -c "import bottom; print(f'bottom {bottom.__version__}')"

C. Documentation

I'm primarily interested in feedback on the migration guide but all of the documentation has been rewritten, so whatever you want to look over is great.