gridworks-base 0.2.1

Gridworks Base

Gridworks Base

This repository serves two purposes:

1. it provides the base class for the default GridWorks actor using pika, the main python package for interacting with RabbitMQ

   • install the gwbase package via

   $ pip install gridworks-base
   

2. It provides scripts for runnig a local dev rabbit broker, which is the recommended way to develop.

Dev Rabbit Broker

All GridWorks repos require a running rabbitMQ dev broker running to pass tests or run dev simulations. Instructions for setting it up:

• Make sure you have docker installed
• Know whether your computer architecture is x86 or arm
• Start the dev broker in a docker container:
  • x86 architecture: ./x86.sh
  • arm architecture: ./arm.sh

Tests for success:

1. go to http://0.0.0.0:15672/ - it should look like this:

- Username/password for the dev rabbit broker: smqPublic/smqPublic - [More info]](https://gridworks.readthedocs.io/en/latest/gridworks-broker.html) on the GridWorks use of rabbit brokers

2. tests pass

poetry install
poetry shell
pytest -v

This, and most other GridWorks repositories, use poetry installed via pipx to handle package management. They are also kicked off via Cookiecutter, which also sets up a template for continuous integration in github actions, package publishing on pypi as well as documentation at pypi.

TODO: EXPLAIN MORE ABOUT CI, BLACK, NOX, DEPENDABOT. A MORE LINKS TO WHY THIS STUFF IS IMPORTANT IN A PRODUCTION SYSTEM.

Hello Rabbit

Quick start for seeing how the actor base can send a message on the rabbit broker. Run hello_rabbit.py (after starting up the dev rabbit broker, see dev broker above) and look at the src/gwbase/actor_base.py code.

TODO: explain more about what this code does. Links to the type registroy, code generation. TODO: create a second hello script with two actors sending heartbeats back and forth.

Distributed under the terms of the MIT license, Gridworks Base is free and open source software.

Credits

This project was generated from @cjolowicz's Hypermodern Python Cookiecutter template.