pyonepassword

Summary

Support creating item objects from non-conformant item data and unknown item types

Fixed

Non-conformant item dictionaries returned by op can now optionally be parsed with relaxed validation (gh-85). See "Added" below.

Added

• An API to relax validation of item dictionaries in the case that op returns non-conforming dictionaries. See ITEM_VALIDATION.md.
• The ability to instantiate item objects and item descriptor lists (e.g., OP.item_get() & OP.item_list()) where an item is an unknown type (gh-86)
  • Where appropriate, a generic_okay kwargs has been added, enabling generic item objects to be returned

Summary

Missed a few housekeeping commits from the development branch

Fixed

Fixed a shellcheck complaint in a docker testing script

Changed

• update .pre-commit-config: bump isort 5.11.3 -> 5.11.4
• refactor pypi_password.py script

Fixed

• Initialize url_obj in OP.login_item_create() to not crash if no URL provided (gh-78)

Changed

• minor tweaks to docker testing scripts

Added

• OP.document_delete() method (gh-52)
• about & version clas methods:
  • OP.about()
  • OP.version()

Fixed

• Include all pyonepassword subpackages by wildcard during build/installation (gh-64)
• Clean *.egg-info during build/installation to ensure proper things get included/excluded

Changed

• Added py.typed marker for mypy type analysis when imported into other projects (gh-48)
• Extensive improvements with type-hinting throughout project
• Added mypy testing to tox.ini
• Add mypy testing to Docker infrastructure

Fixed

• A few bugs found by mypy where the wrong type was being passed to or returned from a method
• A few cases where the wrong type being passed by a caller would have crashed rather than passed back up as a meaningful error
• Properly export all symbols exposed under pyonepassword.apis

Acknowledgements

Thank you to @delfick for extensive advice and patience

Changed

• Fix an issue where op.item_delete() would blow up if the item to be deleted was an unknown (to pyonepassword) type (gh-54)

Changed

Minor updates to ITEM_CREATION.md

Added

New item creation API!

Primarily

• OP.item_create()
• OP.login_item_create()

Additionally, there are a number of new types in support of item creation. See ITEM_CREATION.md for a variety of examples.

Item deletion API:

• OP.item_delete()

Changed

• Bug where op config having no accounts was not handled properly (#43)

Added

• This CHANGELOG file to hopefully serve as a summary of notable changes

Changed

• This release is primarily a refactor of the OP() constructor in order to organize authentication steps
• This should be mostly transparent to the caller, with the following exceptions:
  • New exception class: pyonepassword.api.OPUnknownAccountException
  • New kwargs for OP(): existing_auth and account
  • New constants for existing_auth: EXISTING_AUTH_AVAIL, EXISTING_AUTH_IGNORE, EXISTING_AUTH_REQD

Deprecated

• The following kwargs to OP() are deprecated:
  • use_existing_session: use existing_auth instead
  • account_shorthand: use account instead

Features:

• Add support for "SSH Key" 1Password item category
• Two new classes for SSH Keys:
  • OPSSHKeyItemDescriptor for op item list operations
  • OPSSHKeyItem for op item get operations

Misc:

• Improved testing coverage for several classes related to 'item' objects

Complete rewrite for op CLI tool version 2.

Breaking changes:

• Complete refactor of API, no API compatibility is preserved
• op versions < 2.0 are not supported
• Item creation support has been (temporarily) removed