Skip to content

SDK reference docs missing note about pathlib #161

@conradrushing-toast

Description

@conradrushing-toast

Current Behavior

In the Python SDK examples for Document file handling at https://developer.1password.com/docs/sdks/files, two notes:

  1. The SDK docs aren't versioned - DocumentCreateParams isn't properly exported in v017, it is in v020, so the examples only work on current.
  2. the reference to "Path.read_bytes()" in the DocumentCreateParams is via pathlib, but pathlib isn't imported by onepassword-sdk-python. This may be SOP for Python filehandling, but it might be good to note that in the example. I spent a bit of time hunting for "Path" in the onepassword-sdk-python before realizing it was more generic.

Thanks! Great SDK overall.

Desired Behavior

  1. Version requirements on SDK example / reference pages
  2. Either indicate that pathlib import is required for OP filehandling, or have onepassword-sdk-python import it directly.

Benefits & Value

No response

Additional information

No response

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions