KrustyPlanet/trustcafe-api-wrapper
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: add comprehensive API wrapper documentation

Browse source 
- Add docs/ directory with 6 comprehensive documentation files:
  * INDEX.md - Main navigation and documentation index
  * GETTING_STARTED.md - Setup and configuration guide
  * API_REFERENCE.md - Complete API documentation
  * WRAPPERS.md - High-level wrappers guide
  * CUSTOM_REQUESTS.md - Advanced usage patterns
  * TROUBLESHOOTING.md - Problem-solving guide

- Update README.md with enhanced project information

- Update development.md with expanded documentation context

Extends previous session's documentation work with complete
developer and user-facing documentation.

Closes previous documentation issue.
This commit is contained in:
BarnacleBoy 2026-04-18 01:44:49 +00:00
parent 14346ed02e
commit fd1a1566e9
8 changed files with 4909 additions and 61 deletions
Download patch file Download diff file Expand all files Collapse all files

509
docs/WRAPPERS.md Normal file
View file

@ -0,0 +1,509 @@
# TrustCafé API Wrapped Functions Guide
This guide covers the high-level wrapper functions provided by the TrustCafé API wrapper. Wrappers simplify common operations by handling payload preparation and job execution automatically.
## Table of Contents
- [Overview](#overview)
- [Post Wrappers](#post-wrappers)
- [Comment Wrappers](#comment-wrappers)
- [Wrappers Best Practices](#wrappers-best-practices)
- [Wrapper vs Job](#wrapper-vs-job)
## Overview
### What are Wrappers?
Wrappers are pre-built functions that encapsulate common TrustCafé API operations. They:
- **Simplify usage**: Less boilerplate code
- **Handle payload preparation**: Automatically structure requests
- **Prevent errors**: Built-in validation and defaults
- **Self-documenting**: Clear parameter names and descriptions
### When to Use Wrappers
**Use Wrappers for:**
- Creating and managing content (posts, comments)
- Standard operations with predictable inputs
- Reducing code complexity
- Frequently used patterns
**Use Jobs or Custom Requests when:**
- More control is needed
- Custom parameter combinations
- Operations not covered by wrappers
- Uncommon workflows
### Quick Example
```python
# Using a wrapper (RECOMMENDED)
from trustcafeapiwrapper.wrappers.post.create_post import create_post
API.wrapped(create_post(
"This is my post content",
parent_path="/music"
))
# Using a job (for custom control)
API.run_job('post.create', {
"postText": "Different content",
"parent": {
"pk": "parents-key",
"sk": "parents-key"
}
})
```
## Post Wrappers
### create_post()
Creates a new post with simplified parameters.
```python
from trustcafeapiwrapper.wrappers.post.create_post import create_post
API.wrapped(create_post(
post_text="Post content here",
parent_path="/branch-name",
blur_label=None,
card_url=None,
collaborative=False
))
```
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `post_text` | str | **Required** | The text content of the post |
| `parent_path` | str | `"/"` | Branch path where the post will be created |
| `blur_label` | str | `None` | Optional label for blurring content |
| `card_url` | str | `None` | Optional URL for card preview |
| `collaborative` | bool | `False` | Enable collaborative editing |
**Returns:** dict - Job execution result, contains success information
**Example - Basic Post:**
```python
from trustcafeapiwrapper.wrappers.post.create_post import create_post
API.handle_token()
API.wrapped(create_post(
"Welcome to TrustCafé!",
parent_path="/"
))
```
**Example - Post in a Specific Branch:**
```python
API.wrapped(create_post(
"Music discussion thread",
parent_path="/music",
blur_label=None,
card_url=None,
collaborative=False
))
```
**Example - Blurred Post:**
```python
API.wrapped(create_post(
"Sensitive information",
parent_path="/",
blur_label="secret", # Will blur until labeled
card_url=None,
collaborative=False
))
```
**Example - Collaborative Post:**
```python
API.wrapped(create_post(
"Research paper draft - collaborative editing",
parent_path="/research",
blur_label=None,
card_url=None,
collaborative=True # Enables real-time collaboration
))
```
Example of performing multi-step integration with create_post and a linked resource:
```python
# Create post
created = API.wrapped(create_post("Paper title / author", parent_path="/research"))
# If response includes pk/sk, attach a linked item (structure depends on TrustCafé's link feature)
API.run_job('some.link.create', {
"fromPK": "paper",
"fromSK": created.get('pk'),
"toPK": "external-source",
"toSK": created.get('sk')
})
```
### update_post()
Updates an existing post.
```python
from trustcafeapiwrapper.wrappers.post.update_post import update_post
API.wrapped(update_post(
post_id="post-uuid",
new_post_text="New post content"
))
```
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `post_id` | str | **Required** | The post to update (pk/sk) |
| `new_post_text` | str | **Required** | The new post content |
| Optional fields per the API (e.g., blurLabel, cardUrl, etc.)
**Returns:** dict - Updated post data
**Important:** The post_id parameter should be set to the post's pk/sk. The wrapper internally maps the update parameters to the API's update payload structure.
**Example - Update Text:**
```python
from trustcafeapiwrapper.wrappers.post.update_post import update_post
API.handle_token()
API.wrapped(update_post(
post_id="current-pk-same-as-sk",
new_post_text="Updated content here"
))
```
**Example - Update with Optional Fields:**
```python
API.wrapped(update_post(
post_id="current-pk-same-as-sk",
new_post_text="Updated with new card",
card_url="https://example.com/resource"
))
```
**Example - Update Blur Label:**
```python
API.wrapped(update_post(
post_id="current-pk-same-as-sk",
blur_label="sensitive"
))
```
See update_post.py for mapping of updated fields to the server payload.
## Comment Wrappers
### create_comment()
Creates a new comment on a post.
```python
from trustcafeapiwrapper.wrappers.comment.create_comment import create_comment
API.wrapped(create_comment(
comment_text="This is a comment",
parent_path="/"
))
```
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `comment_text` | str | **Required** | The comment content |
| `parent_path` | str | **Required** | Path to the parent post where comment will be created |
**Returns:** dict - Job execution result, contains success information
**Example - Basic Comment:**
```python
from trustcafeapiwrapper.wrappers.comment.create_comment import create_comment
API.handle_token()
API.wrapped(create_comment(
"Great post! I really enjoyed reading it.",
parent_path="/"
))
```
**Example - Comment on a Post:**
```python
# First get the post to find its path
post = API.run_job('post.get', "target-post-id")
# Then create a comment
API.wrapped(create_comment(
"I agree with your point about this.",
parent_path="/music" # Path to the post
))
```
**Example - Collaborative Comment:**
```python
API.wrapped(create_comment(
"Let's work on this together!",
parent_path="/current-post"
))
```
## Wrappers Best Practices
### 1. Provide Context in Parent Paths
**Good - Explicit paths:**
```python
API.wrapped(create_post(
"Content",
parent_path="/music/discussion" # Clear and specific
))
```
**Bad - Empty paths:**
```python
API.wrapped(create_post(
"Content",
parent_path="/" # Default root - less clear intention
))
```
### 2. Handle Phone Numbers in Content
When phone numbers appear in text, leave them as-is. The API wraps the input string, so `555-1234` stays `555-1234`. No HTML is added.
### 3. Path Normalization
Paths are used directly without extra normalization:
```python
# Use with leading slash
API.wrapped(create_post(
"Content",
parent_path="/music"
))
# Or without (both should work)
API.wrapped(create_post(
"Content",
parent_path="music"
))
```
### 4. Validate Parent Exists
It's good practice to verify the parent path exists:
```python
# Check if branch exists
branches = API.run_job('branch.listbyname', "music")
if branches.get('Items'):
# Branch exists, proceed with post
API.wrapped(create_post(
"Content",
parent_path="/music"
))
else:
print("Branch 'music' does not exist")
```
### 5. Handle Responses
```python
from trustcafeapiwrapper.wrappers.post.create_post import create_post
response = API.wrapped(create_post(
"My post",
parent_path="/music"
))
# Check for success
if response and 'success' in response:
print("Post created successfully!")
print(f"Post ID: {response.get('pk')}")
else:
print("Failed to create post")
print(f"Error: {response.get('error')}")
```
### 6. Error Handling
```python
from trustcafeapiwrapper.wrappers.post.create_post import create_post
import logging
logger = logging.getLogger(__name__)
try:
API.handle_token() # Ensure authenticated
API.wrapped(create_post(
"Post content",
parent_path="/music"
))
logger.info("Post created successfully")
except Exception as e:
logger.error(f"Failed to create post: {e}")
# Handle error - maybe retry, notify admin, etc.
```
## Wrapper vs Job
| Feature | Wrappers | Jobs |
|---------|----------|------|
| **Simplicity** | ⭐⭐⭐⭐⭐ | ⭐⭐ |
| **Flexibility** | ⭐⭐⭐ | ⭐⭐⭐⭐⭐ |
| **Default Values** | ✅ Yes | ❌ No |
| **Parameter Validation** | ✅ Yes | ❌ No |
| **Common Operations** | ✅ Many | ❌ None |
| **Custom Operations** | ❌ No | ✅ Yes |
| **Learning Curve** | Low | High |
### Replacement Examples
**Example 1: Create Post**
```python
# Wrapper - Simple
API.wrapped(create_post(
"Content",
parent_path="/music"
))
# Job - More complex
API.run_job('post.create', {
"postText": "Content",
"parent": {
"pk": "encode(parent_path)",
"sk": "encode(parent_path)"
}
})
```
**Example 2: Update Post**
```python
# Wrapper
API.wrapped(update_post(
post_id="current-pk-same-as-sk",
new_post_text="New content"
))
# Job
API.run_job('post.update', {
"pk": "current-pk-same-as-sk",
"sk": "current-pk-same-as-sk",
"newPostText": "New content"
})
```
**Example 3: Create Comment**
```python
# Wrapper
API.wrapped(create_comment(
"My comment",
parent_path="/post-id"
))
# Job
API.run_job('comment.create', {
"commentText": "My comment",
"parent": {
"pk": "post-id",
"sk": "post-id"
}
})
```
### When to Use Each
**Use Wrappers When:**
- Common operation (create/update post/comment)
- Multiple optional parameters
- Want concise, readable code
- Acceptable default behavior
**Use Jobs When:**
- Rarely used operation
- Very specific parameter combinations
- Custom job names unsupported by wrappers
- Need maximum flexibility
## Creating Custom Wrappers
You can create your own wrappers for repeated operations:
```python
# Custom post wrapper
def create_in_branch(API, branch: str, content: str, create_card: bool = False):
"""
Helper wrapper for creating posts in specific branches.
Args:
API: The APIClient instance
branch: Branch name (e.g., "music", "science")
content: Post content
create_card: Whether to create a card URL
Returns:
dict: API response
"""
card_url = "https://example.com/card" if create_card else None
from trustcafeapiwrapper.wrappers.post.create_post import create_post
return API.wrapped(create_post(
content,
parent_path=f"/{branch}",
card_url=card_url
))
# Usage
API.handle_token()
result = create_in_branch(API, "music", "New music discussion")
# Or with card
result = create_in_branch(API, "science", "Research paper abstract", create_card=True)
```
---
## Summary
Wrappers provide a convenient, safe way to perform common operations with the TrustCafé API. For most use cases, wrappers reduce boilerplate and prevent configuration errors. However, jobs offer greater flexibility when standard wrappers don't meet your needs.
**Choose wisely:**
- Wrappers for standard operations and simplicity
- Jobs for custom operations and maximum control
- Custom wrappers for repeated patterns
---
## Next Steps
- [API Reference](api_reference.md) - Complete list of all API jobs
- [Custom Requests Guide](custom_requests.md) - Making advanced API calls manually
- [Examples](../README.md#examples) - Real-world usage examples