Setting up for local development
This guide describes how to set up your environment for contributing to pytest-streaming.
Prerequisites
- Install Docker to run local emulators and dependencies.
- Ensure you have Just installed for running project tasks.
- Make sure you have Python 3.11+ installed and available in your PATH.
Running the setup script
Run the setup script to install Python dependencies and prepare your environment.
This will install the latest Python version and set up any additional tooling needed for development
- Just
- UV (python dependency management)
- Python
- Yamlfmt
Running the starter just commands
The project uses a justfile to simplify common development tasks. To set up the project, run:
This will install dependencies and perform any other initial project configuration.
Starting docker
To start the required Docker containers (such as Pub/Sub emulator and Pulsar), run:
This will launch all services defined in the docker-compose.yml file. Wait a few seconds for the containers to become healthy before running tests.
Validating setup
To verify your environment is ready, run the following command to check formatting, linting, and run all tests:
All tests, formatting, and linting should pass before you begin development or submit a pull request.