Skip to content

v0.2.1

Choose a tag to compare

@github-actions github-actions released this 27 Jul 15:38

Documentation and one error-message fix. No API changes.

Fixed

  • An unknown constructor argument now raises a useful error. A typo like
    TrueNASClient("wss://nas", passwrd="s3cret") fell through to hostctl's
    SystemHost.__init__ and raised TypeError: SystemHost.__init__() got an unexpected keyword argument 'passwrd' — accurate, but naming an internal
    class rather than the thing the caller got wrong. It now raises
    ValueError: unknown credential argument: 'passwrd' and lists the accepted
    configuration options. Found by testing the documented examples.

Documentation

  • README rewritten for 0.2.0: it still advertised a pytruenas[host] extra
    that no longer exists, said "once published to PyPI", and used a venv layout
    the project no longer follows. Adds the transport table and a
    commands/files section.
  • New Recipes guide
    worked examples for connecting, querying, idempotent upserts, subscriptions,
    running commands, upload/download, several hosts at once, and provisioning
    SSH. Every example was run against a live TrueNAS 26.0.0-BETA.1 host.
  • Filesystem guide expanded with real path examples and a table of which
    operations need SFTP (rename, symlink_to, readlink, resolve have no
    filesystem.* equivalent and raise rather than failing quietly).
  • docs/index.md extras list corrected; both CI workflows dropped a stale
    host extra that pip had been silently warning about.

Full Changelog: v0.2.0...v0.2.1