Skip to content

Commit 61e57c6

Browse files
PsiACEhnwyllmm
andauthored
docs: reorganize docs, align homepage copy, and fix build deps (#167)
## Summary Reorganize the documentation into a Markdown-based structure, update the docs homepage content, and keep the README aligned with the new documentation entry points. ## Solution Description Split the legacy README content into guide pages, move installation into the docs homepage, remove deprecated sections (RAG demo and license) from the guide, add contributing info, and normalize guide heading levels. Added `sphinx-multiversion` to dev dependencies to ensure docs build cleanly. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added comprehensive user guides covering client connection, collection management, data operations, and embedding functions * Added AdminClient documentation with database management examples * Added RAG demo guide with three embedding modes (default, local, API) * Reorganized README to highlight documentation link and quick-start examples * Added contributor development and testing guide <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: wangyunlai <hnwyllmm@126.com>
1 parent 51f549f commit 61e57c6

File tree

15 files changed

+1340
-1293
lines changed

15 files changed

+1340
-1293
lines changed

CONTRIBUTING.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Contributing
2+
3+
Thanks for your interest in contributing to pyseekdb. This file covers development and testing
4+
instructions.
5+
6+
## Development
7+
8+
- Use Python 3.11+.
9+
- This repo uses `uv`. You can override the binary via `UV=...`.
10+
11+
This project uses [uv](https://docs.astral.sh/uv/) as the package manager with
12+
[pdm-backend](https://pdm-backend.fming.dev/) as the build backend. All common development
13+
tasks are unified through the `Makefile`.
14+
15+
### Prerequisites
16+
17+
Install uv:
18+
19+
```bash
20+
# macOS/Linux
21+
curl -LsSf https://astral.sh/uv/install.sh | sh
22+
23+
# Windows
24+
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
25+
26+
# Or via pip
27+
pip install uv
28+
```
29+
30+
### Setup Development Environment
31+
32+
```bash
33+
# Clone the repository
34+
git clone https://github.com/oceanbase/pyseekdb.git
35+
cd pyseekdb
36+
37+
# Install dependencies (all groups)
38+
make install
39+
```
40+
41+
## Make Targets
42+
43+
```bash
44+
make help # Show all available targets
45+
make install # Install dependencies
46+
make test # Run unit tests
47+
make test-integration-embedded # Run embedded integration tests
48+
make docs # Build documentation
49+
make demo # Run RAG demo
50+
make build # Build the package
51+
make clean # Clean build artifacts
52+
```
53+
54+
## Build Artifacts
55+
56+
After running `make build`, the distribution files will be in the `dist/` directory:
57+
- `pyseekdb-<version>.tar.gz` - Source distribution
58+
- `pyseekdb-<version>-py3-none-any.whl` - Wheel distribution
59+
60+
## Testing
61+
62+
```bash
63+
# Run unit tests
64+
make test
65+
66+
# Run embedded integration tests
67+
make test-integration-embedded
68+
69+
# Run specific tests with uv run
70+
uv run pytest tests/integration_tests/ -v -k "server" # server mode (requires seekdb server)
71+
uv run pytest tests/integration_tests/ -v -k "oceanbase" # oceanbase mode (requires OceanBase)
72+
73+
# Run specific test file
74+
uv run pytest tests/integration_tests/test_collection_query.py -v
75+
76+
# Run specific test function
77+
uv run pytest tests/integration_tests/test_collection_query.py::TestCollectionQuery::test_collection_query -v
78+
```

0 commit comments

Comments
 (0)