update

Author: Tom Softreck

Makefile

@@ -23,10 +23,17 @@ help:
 	@echo "  docker           - Build Docker image"
 	@echo "  run-example      - Run an example (use EXAMPLE=name)"
 	@echo "  list-examples    - List available examples"
+	@echo "  logs             - View recent logs (use: make logs LINES=50)"
 	@echo "  view-logs        - View logs for running example"
 	@echo "  stop-example     - Stop a running example"
 	@echo "  docs             - Generate documentation"
 	@echo "  setup-env        - Create example .env file"
+	@echo ""
+	@echo "Testing commands:"
+	@echo "  test-unit        - Run unit tests"
+	@echo "  test-integration - Run integration tests"
+	@echo "  test-e2e         - Run end-to-end tests"
+	@echo "  coverage         - Generate test coverage report"
 
 # Installation
 install:
@@ -148,6 +155,18 @@ version:
 	git tag -a "v$$(poetry version --short)" -m "Version $$(poetry version --short)"
 	@echo "✅ Version bumped and tagged. Don't forget to push with tags: git push --follow-tags"
 
+# View recent logs from the application
+LINES ?= 50  # Default number of lines to show
+LOG_DIR ?= logs  # Default log directory
+
+logs:
+	@echo "📋 Showing last $(LINES) lines of logs from $(LOG_DIR)/"
+	@if [ -d "$(LOG_DIR)" ]; then \
+		find "$(LOG_DIR)" -type f -name "*.log" -exec sh -c 'echo "\n📄 {}:"; tail -n $(LINES) {}' \; 2>/dev/null || echo "No log files found in $(LOG_DIR)/"; \
+	else \
+		echo "Log directory $(LOG_DIR)/ does not exist"; \
+	fi
+
 # Helper to get PYPI_TOKEN from files
 define get_pypi_token
 $(shell \

README.md

@@ -11,6 +11,83 @@
 [![Tests](https://github.com/dialogchain/python/actions/workflows/tests.yml/badge.svg)](https://github.com/dialogchain/python/actions/workflows/tests.yml)
 [![codecov](https://codecov.io/gh/dialogchain/python/graph/badge.svg?token=YOUR-TOKEN-HERE)](https://codecov.io/gh/dialogchain/python)
 
+## 🧪 Testing DialogChain
+
+DialogChain includes a comprehensive test suite to ensure code quality and functionality. Here's how to run the tests and view logs:
+
+### Running Tests
+
+Run the complete test suite:
+
+```bash
+make test
+```
+
+Or run specific test types:
+
+```bash
+# Unit tests
+make test-unit
+
+# Integration tests
+make test-integration
+
+# End-to-end tests
+make test-e2e
+```
+
+### Viewing Test Coverage
+
+Generate a coverage report to see which parts of your code are being tested:
+
+```bash
+make coverage
+```
+
+This will generate an HTML report in the `htmlcov` directory.
+
+### Viewing Logs
+
+View the most recent logs from your application:
+
+```bash
+# Show last 50 lines from all log files
+make logs
+
+# Show a different number of lines
+make logs LINES=100
+
+# Specify a custom log directory
+make logs LOG_DIR=/path/to/logs
+```
+
+### Linting and Code Style
+
+Ensure your code follows the project's style guidelines:
+
+```bash
+# Run linters
+make lint
+
+# Automatically format your code
+make format
+
+# Check types
+make typecheck
+```
+
+### Running in Docker
+
+You can also run tests in a Docker container:
+
+```bash
+# Build the Docker image
+docker build -t dialogchain .
+
+# Run tests in the container
+docker run --rm dialogchain make test
+```
+
 ## 🔍 Network Scanning & Printing
 
 DialogChain includes powerful network scanning capabilities to discover devices like cameras and printers on your local network.