type hinting/docstring/documentation for truenas/api_client

Description

We’ve recently broken our custom websocket client into its own module. (truenas/api_client). This opens up the doors for providing a generic utility that can be used on any major OS (windows/mac/linux/freebsd) to connect to a TrueNAS instance.

We should do the following:

  1. type annotate all the things

  2. write ample docstrings for everything

  3. write a README.md file showing basic/standard usage for the client

As a stretch goal we should do the following:

  1. add Ci/CD to the github repo that actually runs a “linter” tool to validate type safety

Problem/Justification

None

Impact

None

is parent of

Activity

Show:

Bug Clerk August 30, 2024 at 1:00 PM

This issue has now been closed. Comments made after this point may not be viewed by the TrueNAS Teams. Please open a new issue if you have found a problem or need to re-engage with the TrueNAS Engineering Teams.

Bug Clerk August 5, 2024 at 9:18 PM

Complete
Pinned fields
Click on the next to a field label to start pinning.

Details

Assignee

Reporter

Original estimate

Time remaining

0m

Priority

Katalon Platform

Created June 26, 2024 at 4:21 PM
Updated September 4, 2024 at 12:57 PM
Resolved August 30, 2024 at 1:00 PM