Metadata-Version: 2.4
Name: hbase-driver
Version: 1.0.3
Project-URL: Homepage, https://github.com/innovationb1ue/hbase-driver
Project-URL: Issues, https://github.com/innovationb1ue/hbase-driver/issues
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: kazoo
Requires-Dist: protobuf
Dynamic: license-file

# hbase-driver

[![Tests](https://github.com/innovationb1ue/hbase-driver/actions/workflows/ci.yml/badge.svg)](https://github.com/innovationb1ue/hbase-driver/actions)
[![License](https://img.shields.io/badge/license-Apache%202-blue.svg)](LICENSE)

Pure-Python native HBase client (no Thrift). This project implements core HBase regionserver and master RPCs so Python programs can perform table and metadata operations against an HBase cluster.

Status

- Integration test status (local): **77 / 77 tests passing** (2026-02-21) using the custom 3-node Docker cluster.

Quickstart (3-node Docker dev environment)

Prerequisites: Docker and docker-compose installed.

1. Build, start the custom 3-node cluster and run the full test suite:

```bash
./scripts/run_tests_3node.sh
```

2. To run tests against an already-running cluster (fast):

```bash
./scripts/run_tests_3node.sh --no-start
```

3. Run a single test file or case:

```bash
./scripts/run_tests_3node.sh test/test_scan.py
./scripts/run_tests_3node.sh test/test_scan.py::test_scan
```

Legacy single-node dev workflow (still available):

```bash
./scripts/run_tests_docker.sh
```

See TEST_GUIDE.md and DEV_ENV.md for full documentation and troubleshooting steps.

Documentation

- [API Reference](docs/api_reference.md) - Comprehensive API documentation
- [Advanced Usage](docs/advanced_usage.md) - Advanced features and patterns
- [Performance Guide](docs/performance_guide.md) - Performance tuning and optimization
- [Troubleshooting](docs/troubleshooting.md) - Common issues and solutions
- [Migration from happybase](docs/migration_from_happybase.md) - Guide for migrating from happybase/happybase-thrift

