Skip to content

Commit 730ee57

Browse files
committed
Add documentation for vCon Server modules
- Introduced new documentation files: CLAUDE.md, EXTENDING.md, VECTOR_STORAGE.md, example_link.py, and example_storage.py. - CLAUDE.md provides guidance on build and run commands, code style guidelines, and testing practices. - EXTENDING.md outlines how to implement new Link and Storage modules for the vCon Server, including best practices and testing instructions. - VECTOR_STORAGE.md details the implementation and configuration of vector storage modules for semantic search capabilities. - example_link.py and example_storage.py serve as practical examples of link and storage module structures, demonstrating basic functionality and logging practices.
1 parent 1e1b16c commit 730ee57

File tree

5 files changed

+1133
-0
lines changed

5 files changed

+1133
-0
lines changed

docs/CLAUDE.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# CLAUDE.md
2+
3+
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
4+
5+
## Build and Run Commands
6+
- Install dependencies: `poetry install`
7+
- Run server: `docker compose up -d`
8+
- Scale up server: `docker compose up --scale conserver=4 -d`
9+
- Run single test: `poetry run pytest path/to/test_file.py::test_function_name -v`
10+
- Run all tests: `poetry run pytest`
11+
- Format code: `poetry run black .`
12+
13+
## Code Style Guidelines
14+
- Use black for formatting (line length 120, skip string normalization)
15+
- Type annotations are required for function parameters and return values
16+
- Error handling: Use try/except with specific exceptions, log errors with logger
17+
- Imports: Group stdlib, third-party, and local imports separated by blank lines
18+
- Use docstrings for classes, methods, and functions with Args/Returns/Raises
19+
- Tests: Use pytest fixtures, mocks for external services, descriptive test names
20+
- Logging: Use structured logging with appropriate levels (info, debug, error)
21+
- Follow PEP 8 naming conventions (snake_case for functions/variables)
22+
- Use retry patterns with tenacity for external services

0 commit comments

Comments
 (0)