DEVELOPMENT.md

Development

Setting Up Development Environment

Prerequisites

• Python 3.10 or later
• uv for dependency management

Installation

1. Clone the repository:

   git clone https://github.com/connectrpc/connect-python
   cd connect-python

2. Install dependencies:

   uv sync

Development Workflow

We use just as a task runner. Available commands:

# Run all checks
uv run just check

# Format code
uv run just format

# Run type checking
uv run just typecheck

# Run tests
uv run just test

# Run conformance tests
uv run just conformance

Code Style

We use:

• ruff for linting and formatting
• pyright for type checking
• pytest for testing

The project follows strict type checking and formatting standards.

Testing

Unit Tests

uv run just test

Conformance Tests

The project uses the official Connect conformance test suite. Go must be installed to run them.

uv run just conformance

Code Generation

The project includes protobuf code generation for examples and tests:

uv run just generate

Releasing

To release a new version, follow the guide in RELEASE.md.

Documentation

Building Documentation

# Build documentation
uv run just docs

# Serve documentation locally
uv run just docs-serve

Writing Documentation

• Use MyST markdown for documentation files
• Place API documentation in docs/api.md
• Place examples in docs/examples.md
• Update the main docs/index.md for structural changes

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Run the full test suite: uv run just check
5. Submit a pull request

Pull Request Guidelines

• Ensure all tests pass
• Add tests for new functionality
• Update documentation as needed
• Follow the existing code style
• Write clear commit messages