sse-starlette

(β˜… 848)

No description available.

  • .gitignore
  • .pre-commit-config.yaml
  • ARCHITECTURE.md
  • AUTHORS
  • Dockerfile
  • example.png
  • LICENSE
  • Makefile
  • Manifest.in
  • output.png
  • pyproject.toml
  • README.md
  • readme_uvicorn.md
  • uv.lock
  • VERSION

πŸš€ Installation Guide

1. Get the code
git clone https://github.com/sysid/sse-starlette

Downloads the entire project code from GitHub to your computer.

cd sse-starlette

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Python 3 Python is required to use pip.
pip install sse-starlette

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
make test # Unit + docker integration tests

Compiles the code based on the generated build configuration to produce an executable.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install sse-starlette

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

5. Make

Medium
Prerequisites
  • 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 test-unit # Unit tests only (default dev install)

Compiles the code based on the generated build configuration to produce an executable.

make test # Unit + docker integration tests

Compiles the code based on the generated build configuration to produce an executable.

make test-experimentation # Optional experimentation tests (multi-consumer load tests)

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.

Pulled directly from this repo's README.

// repository documentation