Overview
PulseGrid Python is the official PyPI package for trusted backend usage.
Use this package when you want to:
- test authentication
- create client tokens
- inspect projects
- inspect or create channels
- publish server-side messages
- connect to channels over websocket
- inspect presence from Python
Important:
This package is for backend and trusted service code.
Do not expose your PulseGrid secret_key in browser or mobile code.
Setup
1. Make sure Python 3.10+ is installed.
2. Open your terminal in your project.
3. Install PulseGrid from PyPI.
4. Verify the import works.
5. Then move on to the Python quick start docs.
Code example
# Install the package
pip install pulsegrid
# Check package details
pip show pulsegrid
# Simple import test
python -c "from pulsegrid import create_pulsegrid, PulseGridClient; print('PulseGrid Python import ok')"
Notes
Expected result examples:
pip show pulsegrid
may show something like:
Name: pulsegrid
Version: 0.1.0
Import test:
PulseGrid Python import ok