support document editing

[kantandane]

Reading the project issues, the doc and code, it seems like your library doesn't support updating (replacing) a document right now, am I missing something ?

My use case is that i store a zip file in 1Password (as a document), and I would like to be able to update it as well (replacing only the file in 1Password, but keeping the same uuid etc.

Deleting it and Recreating it would be a decent workaround but it seems like document deletion isn't supported yet as well :(

[zcutlip]

Hi @kantandane, thank you for this issue and the great description of your use case

As I understand your use case, no pyonepassword doesn't currently support what you're describing. However, I'm in the process of pulling together a major 4.0 release, the marquee feature of which will be item editing. I don't know if 4.0 will satisfy your requirement exactly but if you're able to do what you're describing via op item edit, then I should be able to support it without too much trouble soon after 4.0, as editing is the main category of op operation this release aims to support.

Just to be sure we're thinking of the same thing: documents in 1Password are a little confusing. There are document items where op item get <document name> would give you the JSON description of a document entry in your vault. Then there are document objects themselves where op document get gives you the literal bytes representing the file. The document item references the document.

As far as deleting, yes, there is both OP.item_delete() to delete a document item as well OP.document_delete() to delete the document object. So you can delete documents. But no you can't currently edit an item and have it point to a new document object.

Let me know if I'm understanding your question correctly, and also please confirm that you can do what you're describing manually via the op command. From there I'll update this issue to track this feature work.

[zcutlip]

Also, I apologize, but my free time to work on pyonepassword is a bit more scarce than normal, so progress has slowed down on feature work. I'm hoping to pick the pace up soon, but in the mean time please bear with me

[kantandane]

Hi @zcutlip
Thank you for your quick answer.

Let me know if I'm understanding your question correctly, and also please confirm that you can do what you're describing manually via the op command. From there I'll update this issue to track this feature work.

What I want to do translated in op commands is :

1. Creating a document test.txt with "test" in it
2. Creating the document item with the binary in it with 1Password

op document create "test.txt" --title "test"

3. Then I get the json response with the UUID of the item, so later I can replace the document with an updated one with the following command:

op document edit <Previously generated UUID> "test.txt"

And voilà, the same 1Password document Item, has now the updated binary file in it

I Hope it is more understandable !

Also, I apologize, but my free time to work on pyonepassword is a bit more scarce than normal, so progress has slowed down on feature work. I'm hoping to pick the pace up soon, but in the mean time please bear with me

Of course, it's an open source project, take all the time you need, i'm glad this lib exists anyway !

[zcutlip]

Oh interesting, somehow op document edit had escaped my attention! I'll have a look at this, but my intuition is this should be fairly straight forward

Thank you for the great GH issue and the clarification

[zcutlip]

Oh, and just to clarify, does OP.document_delete() address your document deletion question?

[zcutlip]

have OP.document_edit() implemented in the dev/150-support-document-editing branch, and it's working in casual testing

need to add support for the optional flags to op document edit including:

• --file-name
• --title
• --tags

Also need to add a suite of test cases

cc: @kantandane

[zcutlip]

This is complete as of pr #178, v4.1.0

You may get v4.1.0 vi PyPI:
pip3 install pyonepassword --upgrade "pyonepassword>=4.1.0"

cc: @kantandane