This document explains how to set up the superclient library for local development.
git clone https://github.com/superstreamlabs/superclient-python.git
cd superclient-python
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
pip install -e . && python -m superclient install_pth
This installs the package in "editable" mode and enables automatic loading, which means:
- Changes to the source code are immediately reflected without reinstalling
- The package is installed in your Python environment
- You can import and use the package normally
- The
.pth
file is installed to enable automatic loading when Python starts
- Edit the source code in the
superclient/
directory - Changes are immediately available (no reinstallation needed)
- Test your changes by running examples or your own code
pip uninstall superstream-clients && find venv/lib/python*/site-packages -name "superclient-init.pth" -delete && rm -rf build/ dist/ superstream_clients.egg-info/ && find . -name "*.pyc" -delete && find . -name "__pycache__" -type d -exec rm -rf {} +
This single command:
- Uninstalls the superclient package
- Removes the .pth file
- Cleans up build artifacts
- Removes cached Python files