Contributing / contribution guide

Instructions for contributors

Please help out to add features in the library that are missing or prepare pull requests with solutions to any bug you may encounter during execution.

Clone the repo and install the required dependencies. poetry is the default way of installing the development environment.

code/ $ git clone [email protected]:kalaspuff/tomodachi
code/ $ cd tomodachi

# Using poetry
tomodachi/ $ poetry install -E uvloop -E protobuf -E aiodns

# or alternatively with pip
tomodachi/ $ pip install -U .[uvloop,protobuf,aiodns]

# Verify that the tomodachi CLI is installed
tomodachi/ $ tomodachi --version
tomodachi/ $ python -m tomodachi --version

# Finally to start services
tomodachi/ $ tomodachi run examples/basic_examples/

# Alternative – instead of tomodachi cli, use as a module
tomodachi/ $ python -m examples/basic_examples/

It's highly recommended to use poetry for building and handling the dependencies, and poetry is best installed using installation script provided in the poetry documentation. Read more about poetry at

Development – linting and tests

This section is only relevant if you're adding functionality to the tomodachi repo.

There are GitHub actions enabled on "push" to automate test cases for the most common use-cases, as well as performing lint tests, type hint checking, etc. You can also run them on your own, see Makefile for a helping hand.

tomodachi/ $ make test
tomodachi/ $ make flake8
tomodachi/ $ make mypy

Note that the code must conform to the black code style and imports must be sorted alphabetically, and automatically separated into sections and by type. These code format styles will be checked in CI and must be followed for any branch or PR to pass all of the tests runs 🖤

Use the following make commands to run these tasks on demand:

tomodachi/ $ make black
# Runs: black tomodachi/ examples/ tests/

tomodachi/ $ make isort
# Runs: isort tomodachi/ examples/ tests/