1Password / connect-sdk-python

Python SDK for 1Password Connect
https://developer.1password.com/docs/connect
MIT License
200 stars 30 forks source link

Clarify the Future of This Project on OP Website #112

Closed DustinMoriarty closed 16 hours ago

DustinMoriarty commented 2 days ago

Summary

This connect-sdk-python library is not in the list of supported SDK's on the OP Documentation. However, onepasword-connect-python is linked. Onepassword-connect-python is not yet published to PyPi and is not yet at version 1.0.0. This repo, Connect-sdk-python, appears to be more mature than Onepassword-connect-python, yet it is not mentioned. We need clarity about the future support plan for this connect-sdk-python. Right now, there does not appear to be a production ready python SDK for OP that is endorsed by OP in the documentation. We are reluctant to use this SDK because we don't know if OP will continue to support it and we are reluctant to use onepasword-connect-python because it does not appear stable yet.

Use cases

We need to know OP's Python SDK support plan so that we can plan our current and future use of OP SDK's.

Proposed solution

Document the current state of this library and it's support plan in the OP Documentation and in the README.md file of this repo. If this library is planned to stop receiving updates at some point, publish an end of life (EOL) date. Otherwise, state that this library is expected to remain supported for the foreseeable future and also link to this library from the documentation.

Is there a workaround to accomplish this today?

We are currently planning to not use any OP Python SDK. We are currently wrapping the OP CLI with Java instead, which is a fairly ugly solution.

References & Prior Work

naziba321 commented 2 days ago

Hi @DustinMoriarty, thank you for raising this!

This connect-sdk-python repo is for interacting with a Connect server, while the onepassword-sdk-python is for interacting directly to 1Password. These are two different SDKs and they are used for different purposes, and they are both currently actively maintained.
The documentation you are looking at is for interacting directly with 1Password and currently this works with service accounts. We also mention the Connect SDK for python in our guide for setting up Connect.

I’ve noticed you mention trying to solve your use case by building a CLI wrapper in Java. While we currently don’t support this language, if you’re currently using Connect, then you might want to check out this community-built Java SDK for Connect.

As for Python SDK, you have the following options:

DustinMoriarty commented 2 days ago

Thanks for the clarification @naziba321 ! That was very confusing to me. My understanding was that connection without the connect server was not supported. Good to know!

edif2008 commented 16 hours ago

Closing this as the question seems to have been answered. Feel free to reopen if you have further questions.