KrustyPlanet/trustcafe-api-wrapper
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
trustcafe-api-wrapper/docs/INDEX.md
BarnacleBoy a223bcb27a doc: audit pass — fix env= bug, params, pagination, missing wrappers, broken examples 
- env= -> environment= across all docs (Pydantic silently ignores env=)
- Remove __version__ check (doesn't exist in module)
- Fix APIClient(debug=True) missing required client_id/secret
- Fix post.listremoved usage (takes no postId, just lists removed posts)
- Fix JS true/false -> Python True/False in code blocks
- Fix parameter names: branchName->branch_slug, username->user_slug, postId->post_id
- Add missing lastEvaluatedKey param docs for list jobs
- Note post.listpublic as unauthenticated endpoint
- Fix pagination examples (LastEvaluatedKey, not ExclusiveStartKey dict)
- Remove non-existent headers param from make_request example
- Fix branch.listbyname example (takes no name arg)
- Add 4 missing wrapper docs: follow, react, trust, votecast
- Fix broken internal links (case-sensitive filenames)
- Fix <environment>_handle_token template artifact
- Add CODE_BUGS.md documenting 4 code bugs found during audit
2026-04-18 22:58:33 +00:00

4.6 KiB
Raw Blame History

TrustCafé API Wrapper - Documentation Index

Complete documentation for the TrustCafé API wrapper.

Getting Started

New to the wrapper? Start here.

Core Usage

Learn how to use the API wrapper effectively.

Development

Contributing or extending the wrapper.

Support and Troubleshooting

Having issues? Find solutions here.

Quick Links

For New Users

  1. Installation
  2. Authentication Setup
  3. First API Call
  4. Basic Usage

For In-Depth Learning

  1. Wrappers - Start here for easiest usage
  2. API Reference - Deep dive into all jobs
  3. Creating Custom Wrappers

For Developers

  1. Extending the Wrapper
  2. Testing Guide
  3. Contributing
  4. Known Limitations

Documentation Contents

Getting Started (GETTING_STARTED.md)

  • Installation steps
  • API credentials setup
  • Environment configuration
  • First API call example
  • Token management best practices
  • Setup patterns for different environments

Wrappers Guide (WRAPPERS.md)

  • Overview of wrapper system
  • Post wrapper documentation (create_post, update_post)
  • Comment wrapper documentation (create_comment)
  • Interaction wrappers (follow, react, trust, votecast)
  • Wrapper best practices
  • Wrapper vs Job comparison
  • Creating custom wrappers

API Reference (API_REFERENCE.md)

  • All available Jobs
  • Complete job parameters and return values
  • Authentication job documentation
  • Post, Comment, UserProfile, Follow, Vote jobs
  • Reaction, Notification, Trust, Branch jobs
  • Feed operations
  • Error handling patterns
  • Pagination guide

Custom Requests Guide (CUSTOM_REQUESTS.md)

  • Using the make_request method
  • Advanced usage patterns
  • Pagination strategies
  • Batch operations
  • Error handling for custom calls
  • Complex query examples

Troubleshooting Guide (TROUBLESHOOTING.md)

  • Authentication issues
  • Connection problems
  • Token management errors
  • API call issues
  • Environment issues
  • Data handling problems
  • Performance issues
  • Debugging strategies

Development Guide (development.md)

  • Project structure
  • Design decisions and debates
  • Known limitations
  • Missing features
  • Future enhancements
  • Contributing guidelines
  • Testing guide
  • Extension instructions

Support

If you can't find the answer you're looking for:

  1. Check the FAQs section - Common questions and answers
  2. Review the Troubleshooting guide - For specific error handling
  3. Contact WikiTribune team - Via company channels
  4. File an issue on GitLab - Repository Issues

Changelog

Document version updates should be listed here.

v0.2.0 (Current Documentation)

  • Complete rewrite and enhancement of all documentation
  • Added full API reference
  • Added wrappers guide (including follow, react, trust, votecast)
  • Added custom requests guide
  • Added detailed troubleshooting section
  • Enhanced development documentation
  • Improved README.md structure and examples

v0.1.0.13 (Package Version / Initial Release)

  • Initial release with basic documentation
  • Minimum set of jobs and wrappers

Contributing to Documentation

If you find any documentation issues:

  1. Typos or errors - Correct in the markdown file
  2. Outdated examples - Update with correct code
  3. Missing information - Add to the appropriate section
  4. Unclear explanations - Improve wording for clarity

When contributing documentation remember:

  • Keep examples working
  • Maintain consistent formatting
  • Use proper markdown syntax
  • Link to related documentation
  • Update this INDEX.md if structure changes

Last Updated: April 18, 2026