Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
78 lines (56 loc) · 2.06 KB

CONTRIBUTING.md

File metadata and controls

78 lines (56 loc) · 2.06 KB

Contributing

Thanks for your interest in contributing to pyseekdb. This file covers development and testing instructions.

Development

  • Use Python 3.11+.
  • This repo uses uv. You can override the binary via UV=....

This project uses uv as the package manager with pdm-backend as the build backend. All common development tasks are unified through the Makefile.

Prerequisites

Install uv:

# macOS/Linux
curl -LsSf https://astral.sh/uv/install.sh | sh

# Windows
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

# Or via pip
pip install uv

Setup Development Environment

# Clone the repository
git clone https://github.com/oceanbase/pyseekdb.git
cd pyseekdb

# Install dependencies (all groups)
make install

Make Targets

make help                      # Show all available targets
make install                   # Install dependencies
make test                      # Run unit tests
make test-integration-embedded # Run embedded integration tests
make docs                      # Build documentation
make demo                      # Run RAG demo
make build                     # Build the package
make clean                     # Clean build artifacts

Build Artifacts

After running make build, the distribution files will be in the dist/ directory:

  • pyseekdb-<version>.tar.gz - Source distribution
  • pyseekdb-<version>-py3-none-any.whl - Wheel distribution

Testing

# Run unit tests
make test

# Run embedded integration tests
make test-integration-embedded

# Run specific tests with uv run
uv run pytest tests/integration_tests/ -v -k "server"     # server mode (requires seekdb server)
uv run pytest tests/integration_tests/ -v -k "oceanbase"  # oceanbase mode (requires OceanBase)

# Run specific test file
uv run pytest tests/integration_tests/test_collection_query.py -v

# Run specific test function
uv run pytest tests/integration_tests/test_collection_query.py::TestCollectionQuery::test_collection_query -v