tomodachi
💻 Microservice lib designed to ease service building using Python and asyncio, with ready to use support for HTTP + WS, AWS SNS+SQS, RabbitMQ / AMQP, middlewares, envelopes, logging, lifecycles. Extend to GraphQL, protobuf, etc.
File Explorer
Download Latest Version (.zip)- codeql-config.yml
- codeql-analysis.yml
- pythonpackage.yml
- dependabot.yml
- FUNDING.yml
- microservice-in-30-seconds-white.gif
- microservice-in-30-seconds.gif
- tomodachi-in-docker.png
- tomodachi-logger.png
- tomodachi-run-service.png
- tomodachi-usage.png
- index.html
- websocket_service.py
- amqp_middleware_service.py
- amqp_service.py
- aws_sns_sqs_fifo_service.py
- aws_sns_sqs_middleware_service.py
- aws_sns_sqs_service.py
- aws_sns_sqs_service_localstack.py
- http_auth_service.py
- http_basic_auth_middleware.py
- http_middleware_service.py
- http_simple_service.py
- scheduler_example.py
- http_port.json
- watcher.json
- service.py
- docker_build.sh
- docker_run.sh
- docker-compose.yml
- Dockerfile
- README.md
- service_a.py
- service_b.py
- service_send_message.py
- config_file.json
- invalid_config_file.json
- __init__.py
- message_pb2.py
- message_pb2.pyi
- __init__.py
- code.py
- os.py
- __init__.py
- import_file.py
- code.py
- service.py
- test.py
- code.py
- test-copy.py
- test.py
- amqp_service_invalid_credentials.py
- amqp_service_with_credentials.py
- amqp_service_with_credentials_with_custom_envelope.py
- amqp_service_with_credentials_without_envelope.py
- auto_closing_service_exit_call.py
- auto_closing_service_exit_code_1.py
- auto_closing_service_exit_code_128.py
- auto_closing_service_sigint.py
- auto_closing_service_sigterm.py
- aws_sns_sqs_service_dead_letter_queue.py
- aws_sns_sqs_service_invalid_credentials.py
- aws_sns_sqs_service_with_credentials.py
- aws_sns_sqs_service_with_credentials_with_custom_envelope.py
- aws_sns_sqs_service_with_credentials_with_encryption_at_rest.py
- aws_sns_sqs_service_with_credentials_without_envelope.py
- aws_sns_sqs_service_with_middleware.py
- aws_sns_sqs_service_with_middleware_sqs_send_message.py
- decorated_functions_service.py
- dummy_protobuf_service.py
- dummy_service.py
- empty_service.py
- exception_service.py
- exception_service_init.py
- http_access_log_service.py
- http_service.py
- http_service_same_port.py
- import_error_service.py
- invalid_service.py
- logging_service.py
- mock_decorator_service.py
- non_decorated_service.py
- opentelemetry_no_sampling_service.py
- opentelemetry_service.py
- relative_service.py
- schedule_service.py
- start_process_service_http_0.py
- start_process_service_http_1.py
- start_process_service_http_2.py
- start_process_service_schedule.py
- syntax_error_service.py
- wrapped_invoker_function_service.py
- image.png
- file.py
- file.py
- .gitignore
- file.py
- conftest.py
- run_example_service.py
- run_test_service_helper.py
- test_amqp_service_invalid_credentials.py
- test_amqp_service_with_credentials.py
- test_amqp_transport.py
- test_aws_credentials.py
- test_aws_sns_sqs_service_dead_letter_queue.py
- test_aws_sns_sqs_service_with_credentials.py
- test_aws_sns_sqs_service_with_credentials_with_custom_envelope.py
- test_aws_sns_sqs_service_with_credentials_with_encryption_at_rest.py
- test_aws_sns_sqs_service_with_credentials_without_envelope.py
- test_aws_sns_sqs_service_with_middleware.py
- test_aws_sns_sqs_service_with_middleware_sqs_send_message.py
- test_aws_sns_sqs_service_without_credentials.py
- test_aws_sns_sqs_transport.py
- test_banner.py
- test_build_time_output.py
- test_cli.py
- test_configs.py
- test_crontab_parser.py
- test_decorated_functions_service.py
- test_dummy_service.py
- test_empty_service.py
- test_envelope.py
- test_exception_service.py
- test_http_service.py
- test_invalid_services.py
- test_logging.py
- test_logging_internals.py
- test_message_attributes_parsing.py
- test_meta_imports.py
- test_mock_decorator.py
- test_non_packaged_imported_service.py
- test_opentelemetry_distro_configurator.py
- test_opentelemetry_no_sampling_service.py
- test_opentelemetry_service.py
- test_options.py
- test_relative_imports.py
- test_schedule_service.py
- test_start_2_process_http_0.py
- test_start_process_http_1.py
- test_start_process_http_2.py
- test_start_process_schedule.py
- test_validation.py
- test_version.py
- test_watcher.py
- test_wrapped_invoker_function.py
- type_hinting_validation.py
- __init__.py
- __init__.py
- __init__.pyi
- aws_sns_registration.py
- dummy_registry.py
- __init__.py
- sns_sqs_message_pb2.py
- sns_sqs_message_pb2.pyi
- __init__.py
- sns_sqs_message.proto
- __init__.py
- __init__.pyi
- json_base.py
- protobuf_base.py
- __init__.py
- aiobotocore_connector.py
- aws_credentials.py
- banner.py
- build_time.py
- colors.py
- crontab.py
- dict.py
- execution_context.py
- logging.py
- middleware.py
- safe_modules.py
- __init__.py
- base.py
- decorator.py
- __init__.py
- auto_instrumentation.py
- distro.py
- environment_variables.py
- exemplars.py
- instrumentation.py
- logging.py
- middleware.py
- prometheus.py
- __init__.py
- definitions.py
- interface.py
- __init__.py
- __init__.pyi
- json_base.py
- protobuf_base.py
- __main__.py
- __init__.py
- __init__.pyi
- amqp.py
- aws_sns_sqs.py
- awssnssqs.py
- awssnssqs.pyi
- http.py
- schedule.py
- __init__.py
- validation.py
- __init__.py
- __init__.pyi
- __main__.py
- __version__.py
- _exception.py
- _importer.py
- config.py
- container.py
- importer.py
- launcher.py
- logging.py
- py.typed
- watcher.py
- .codecov.yml
- .gitignore
- CHANGELOG.md
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- LICENSE
- Makefile
- poetry.lock
- pyproject.toml
- README.md
- SECURITY.md
# Installation Guide
1. Get the code
git clone https://github.com/kalaspuff/tomodachi
Downloads the entire project code from GitHub to your computer.
cd tomodachi
Moves into the project folder you just downloaded.
2. Python
Easy RecommendedPrerequisites
local ~$ pip install tomodachi
Installs the Python libraries listed in requirements.txt (or similar).
local ~/code/service$ python -m tomodachi.run service.py
Runs the Python script (or module).
RUN pip install tomodachi
Installs the Python libraries listed in requirements.txt (or similar).
local ~$ pip install tomodachi[opentelemetry]
Installs the Python libraries listed in requirements.txt (or similar).
local ~$ pip install tomodachi[opentelemetry,opentelemetry-exporter-prometheus]
Installs the Python libraries listed in requirements.txt (or similar).
If it runs without errors and prints output in the terminal, it worked.
Pulled directly from this repo's README.
3. Make
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make
Compiles the code based on the generated build configuration to produce an executable.
If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation
Was this content helpful?
(0 ratings)