Python Publisher Subscriber

Python Version License Flask WebSocket

A high-performance, real-time Publisher-Subscriber system built with Flask, Flask-SocketIO, and SQLite.

Features • Installation • Quick Start • Contributing

🚀 Features

📋 Requirements

🔧 Installation

From Source

# Clone the repository
git clone https://github.com/venantvr/Python.Publisher.Subscriber.git
cd Python.Publisher.Subscriber
# Create virtual environment
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
# Install in development mode
pip install -r requirements-dev.txt
pip install -e .

Using Docker

# Using Docker Compose
docker-compose up -d
# Or build and run manually
docker build -t python.publisher.subscriber:latest .
docker run -p 5000:5000 python.publisher.subscriber:latest

🚀 Quick Start

1. Start the Server

# Run directly
python src/pubsub_ws.py

2. Publish Messages

Using curl

curl -X POST http://localhost:5000/publish \
 -H "Content-Type: application/json" \
 -d '{"topic": "sports", "message": "Goal scored!"}'

Using Python

import requests
response = requests.post(
 "http://localhost:5000/publish",
 json={"topic": "sports", "message": "Goal scored!"}
)

3. Subscribe to Topics

Using Python Client

from pubsub import PubSubClient
def handle_sports_message(message):
 print(f"Sports update: {message}")
def handle_news_message(message):
 print(f"News update: {message}")
# Create client and connect
client = PubSubClient(
 consumer_name="alice",
 topics=["sports", "news"]
)
# Register message handlers
client.register_handler("sports", handle_sports_message)
client.register_handler("news", handle_news_message)
# Start listening
client.start()

Using Web Interface

📁 Project Structure

Python.Publisher.Subscriber/
├── src/ # Source code
│ ├── pubsub/ # Core library modules
│ │ ├── __init__.py
│ │ ├── pubsub_client.py
│ │ └── pubsub_message.py
│ ├── pubsub_ws.py # Main server application
│ └── client.py # Client implementation
├── tests/ # Test suite
│ ├── test_pubsub_ws.py
│ └── test_pubsub_client.py
├── config/ # Configuration files
├── docs/ # Documentation
├── migrations/ # Database migrations
├── static/ # Static web files
├── .github/ # GitHub Actions workflows
│ └── workflows/
│ ├── ci.yml
│ └── release.yml
├── Dockerfile # Docker configuration
├── docker-compose.yml # Docker Compose setup
├── Makefile # Development commands
├── pyproject.toml # Python project configuration
├── setup.py # Package setup
├── requirements.txt # Python dependencies
└── README.md # This file

🧪 Testing

Run Tests

# Run all tests
make test
# Run specific test file
pytest tests/test_pubsub_ws.py -v
# Run in watch mode
pytest-watch tests/ -v

🛠️ Development

Setup Development Environment

# Install development dependencies
make install

Available Make Commands

make help # Show all available commands
make test # Run tests
make clean # Clean generated files
make install # Install dependencies
make update # Update dependencies

📊 Database Schema

Messages Table

Subscriptions Table

Consumptions Table

🔌 API Reference

REST Endpoints

POST /publish

{
 "topic": "string",
 "message": "string"
}

GET /health

WebSocket Events

Client → Server

{
 "consumer": "string",
 "topics": [
 "string"
 ]
}

{
 "topic": "string",
 "message": "string"
}

Server → Client

🐳 Docker Deployment

Using Docker Compose (Recommended)

# Start all services
docker-compose up -d
# View logs
docker-compose logs -f
# Stop services
docker-compose down

Manual Docker Build

# Build image
docker build -t python.publisher.subscriber:latest .
# Run container
docker run -d \
 -p 5000:5000 \
 -v $(pwd)/pubsub.db:/app/pubsub.db \
 --name pubsub-server \
 python.publisher.subscriber:latest

📈 Monitoring

Health Check

curl http://localhost:5000/health

Metrics

🔒 Security

🤝 Contributing

Development Guidelines

📄 License

🙏 Acknowledgments

📚 Documentation

📧 Support

🗺️ Roadmap

Stack