Skip to content

Conversation

@mateuscardosodeveloper
Copy link
Contributor

@mateuscardosodeveloper mateuscardosodeveloper commented Nov 14, 2025

What does PR do?

📊 Complete Dashboards & Widgets Implementation

This PR enhances the Dashboards class with comprehensive Widgets support, modernized documentation, and extensive test coverage for the TagoIO Python SDK.

🎯 Core Enhancements

New Widgets Class:

  • Complete implementation with 10 methods for widget lifecycle management
  • Methods: create, edit, delete, info, getData, sendData, editData, deleteData, editResource, tokenGenerate
  • Full CRUD operations for widget data and resources
  • Token generation for widget embedding

Dashboards Class Updates:

  • All 9 methods updated with improved documentation
  • Modernized URLs to new TagoIO docs structure (docs.tago.io)
  • Enhanced docstrings with clear examples and permission notes

📚 Comprehensive Documentation

RST Documentation (Sphinx):

  • Complete TypedDict documentation in Dashboard_Type.rst (23 types documented)
  • Full method documentation in index.rst with code examples
  • All Widgets methods documented with usage examples
  • Zero warnings/errors in Sphinx build

Type Definitions:

  • Enhanced Dashboards_Type.py with improved TypedDict definitions
  • Better type hints for all parameters and return values
  • Clear descriptions for complex types like blueprint_devices, WidgetInfo, etc.

This implementation provides developers with a complete, well-documented interface for managing TagoIO dashboards and widgets programmatically! 🎨✨

JIRA cards

SDKPY-146

Type of alteration

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update

- Add getAccountInfo, updateAccountInfo, getAccountStatistics methods
- Add getLimits method for account resource limits
- Add complete type definitions for account operations
- Update documentation with comprehensive examples
- Add unit tests for all new methods (27 tests passing)
…ntation

Added listSnippets() and getSnippetFile() methods to fetch analysis code examples from TagoIO's public repository. Enhanced all existing methods with comprehensive docstrings following the Account class pattern, including descriptions, references, and practical examples. Updated type definitions to support new snippet functionality with SnippetRuntime, SnippetItem, and SnippetsListResponse types. Expanded test coverage with 8 new test cases and updated RST documentation with detailed method descriptions and code examples.
Expanded regions.py with EU region support, TDeploy project integration, and runtime region caching. Refactored Analysis class to support async/await execution patterns with improved error handling and console service integration. Removed deprecated api_socket.py infrastructure and added JSONParseSafe utility for safer JSON parsing. Updated Analysis type definitions with new constructor params and function signatures. Added comprehensive region tests covering TDeploy and multi-region scenarios.
… documentation

Added complete Widgets class implementation with 10 methods for widget management (create, edit, delete, info, getData, sendData, editData, deleteData, editResource, tokenGenerate). Updated Dashboards class with improved method documentation and modernized URLs. Enhanced TypedDict definitions and created comprehensive RST documentation for both Dashboards and Widgets, including all types and methods with code examples. Added extensive test coverage for all dashboard operations.
@mateuscardosodeveloper mateuscardosodeveloper changed the base branch from main to feat/update-analyses-class-and-enable-regions/SDKPY-144 November 14, 2025 21:00
@mateuscardosodeveloper mateuscardosodeveloper added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 14, 2025
Base automatically changed from feat/update-analyses-class-and-enable-regions/SDKPY-144 to feat/updated-account-class/SDKPY-143 December 9, 2025 19:23
Base automatically changed from feat/updated-account-class/SDKPY-143 to main December 9, 2025 19:24
Copy link
Member

@felipefdl felipefdl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Finding: duplicate TypedDict name 'blueprint_devices' (lines ~56 and ~160) means the second definition overwrites the first. The exported type in code/docs drops the earlier fields used by DashboardInfo, so blueprint configuration is misrepresented. Needs rename or consolidation before merge.

Renamed duplicate 'blueprint_devices' TypedDict definitions to prevent type shadowing. The first definition is now 'BlueprintDeviceConfig' (used by DashboardInfo for dashboard configuration) and the second is 'BlueprintDeviceOrigin' (used by GetDataModel for widget data queries). Updated all references in code and documentation to maintain consistency.
Copy link
Member

@felipefdl felipefdl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM after fix: BlueprintDeviceConfig/Origin split resolves prior type overwrite.

* feat: add chunk management and data backup/restore methods to Devices class

Implemented four new methods to achieve feature parity with JavaScript SDK:
- getChunk: retrieve chunk information from immutable devices
- deleteChunk: delete specific chunks from immutable devices
- dataBackup: export device data to TagoIO Files with CSV format
- dataRestore: import device data from CSV files

Added corresponding TypedDict definitions for type safety and updated all existing method docstrings to follow consistent documentation pattern.

* docs: add comprehensive Sphinx RST documentation for Devices class

Documented all 21 Devices class methods with descriptions, parameters, return types, and code examples. Added TypedDict documentation for new data structures including DeviceChunkData, DeviceDataBackup, DeviceDataBackupResponse, and DeviceDataRestore.

All documentation follows RST formatting standards with proper cross-references and builds successfully without warnings.

* fix: correct sentStatus parameter handling in paramList method

The sentStatus boolean parameter was being passed directly to the API query, but the API expects a lowercase string representation. Updated to convert boolean to 'true'/'false' string format and handle None values properly.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

* fix: update sentStatus parameter handling to check for None explicitly

* feat/update-class-networks/SDKPY-148 (#56)

* feat: add missing methods and complete Networks class implementation

Implemented 6 missing methods (create, edit, delete, tokenList, tokenCreate, tokenDelete) to achieve feature parity with JavaScript SDK. Added 3 new TypedDict definitions (NetworkTokenInfo, NetworkQuery, ListTokenQuery) for type safety. All methods include comprehensive docstrings following the standard pattern with description, documentation links, and examples.

* docs: add comprehensive Sphinx RST documentation for Networks class

Added complete RST documentation for all 8 Networks class methods and 3 new TypedDict definitions. Documentation includes detailed parameter descriptions, return types, code examples, and links to official TagoIO documentation following the established pattern.

* feat/update-class-profile/SDKPY-149 (#57)

* feat: add comprehensive Profile class implementation with all methods

Added complete implementation of Profile resource management including profile CRUD operations, team management, token operations, usage statistics, and audit logs. Includes new TypedDict definitions and comprehensive test coverage for all methods.

* docs: add comprehensive Sphinx RST documentation for Profile class

Added complete RST documentation for all Profile methods and TypedDict definitions. Includes 10 new TypedDict blocks in Profile_Types.rst and all 17 methods documented in index.rst with proper formatting and cross-references.

* docs: update Help Center link to the new TagoIO Support URL

* fix: update resource references from 'resources.profiles' to 'resources.profile' in doc string examples

* feat/update-class-run/SDKPY-150 (#58)

* feat: add comprehensive documentation and tests for Run class

Add detailed docstrings for all Run class methods with usage examples and authorization policy references. Include new EmailTestData type for email testing functionality. Implement comprehensive test suite covering all Run methods with mocked API responses.

* docs: update Sphinx documentation for Run class methods

Update RST documentation with detailed method descriptions, usage examples, and authorization policy references. Add EmailTestData type documentation and restructure all Run method docs with consistent formatting and Help Center links.

* feat: make query parameter optional in Run.listUsers method

The query parameter is now optional with an empty dict as default value, making it easier to retrieve all users without specifying query filters.

* feat: update listUsers method to use None as default for query parameter

---------

Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
@mateuscardosodeveloper mateuscardosodeveloper merged commit 328455f into main Jan 12, 2026
6 checks passed
@mateuscardosodeveloper mateuscardosodeveloper deleted the feat/update-class-dashboards/SDKPY-146 branch January 12, 2026 17:43
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 enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants