Skip to content

Conversation

@garotm
Copy link
Member

@garotm garotm commented Oct 10, 2025

Note

Revamps README to cover v2.0 breaking changes, new exception-driven usage, stricter token validation, and Python 3.9+ support.

  • Documentation (README.md):
    • v2.0 Highlights:
      • Adds breaking changes section and migration guide.
      • Switches guidance to exception-based error handling with specific exceptions.
      • Emphasizes strict token format validation and structured logging.
    • Usage:
      • Updates example to import and handle TokenNotFoundError, InvalidTokenError, PlatformNotSupportedError, CredentialHelperError and print masked token.
    • Features:
      • Consolidates and expands features: token validation, structured logging, robust credential parsing/sanitization, detailed exception hierarchy.
    • Prerequisites:
      • Raises Python requirement from 3.6+ to 3.9+.
    • Troubleshooting:
      • Adds steps referencing specific exceptions and invalid token format guidance.
    • License:
      • Links LICENSE file explicitly.

Written by Cursor Bugbot for commit 1e3fc2a. This will update automatically on new commits. Configure here.

@garotm garotm self-assigned this Oct 10, 2025
@garotm garotm added the documentation Improvements or additions to documentation label Oct 10, 2025
@garotm garotm added this to fleXRP Oct 10, 2025
@sonarqubecloud
Copy link

@garotm garotm moved this to In Progress in fleXRP Oct 10, 2025
@garotm garotm merged commit 820f41e into main Oct 10, 2025
18 checks passed
@github-project-automation github-project-automation bot moved this from In Progress to Done in fleXRP Oct 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants