Add documentation around oauth2client deprecation #165
Conversation
|
CI failure is because of lint, unrelated. I'll send another PR to fix that. |
| @@ -22,6 +22,8 @@ also provides integration with several HTTP libraries. | |||
| :mod:`urllib3 <google.auth.transport.urllib3>`, and | |||
| :mod:`gRPC <google.auth.transport.grpc>`. | |||
|
|
|||
| .. note:: ``oauth2client`` was recently deprecated in favor of this library. For more details on the deprecation, see :doc:`oauth2client-deprecation`. | |||
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
| @@ -0,0 +1,62 @@ | |||
| :orphan: | |||
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
docs/oauth2client-deprecation.rst
Outdated
| Reasons for deprecation | ||
| ----------------------- | ||
|
|
||
| #. Lack of ownership: ``oauth2client`` has lacked a definitive owner since around 2013. |
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
docs/oauth2client-deprecation.rst
Outdated
| #. Clear ownership: google-auth is owned by the teams that maintain the `Cloud Client Libraries`_, `gRPC`_, and the `Code Samples for Google Cloud Platform`_. | ||
| #. Thought-out design: using the lessons learned from ``oauth2client``, we have designed a better module and class hierarchy. The ``v1.0.0`` release of this library should provide long-term API stability. | ||
| #. Modern, secure, and extensible transports: ``google-auth`` supports `urllib3`_, `requests`_, `gRPC`_, and has `legacy support for httplib2`_ to help clients migration. It is transport agnostic and has explicit support for adding new transports. | ||
| #. Clear purpose and goals: ``google-auth`` is explicitly focused on Google-specific authentication, especially the server-to-server use case. |
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
docs/oauth2client-deprecation.rst
Outdated
|
|
||
| The unsupported features are: | ||
|
|
||
| #. Support for obtaining user credentials. While this library has support for using user credentials, there are no provisions in the core library for doing the three-party OAuth 2.0 flow to obtain authorization from a user. Instead, we are opting to provide a separate package that does integration with `oauthlib`_, `google-auth-oauthlib`_. When that library has a stable API, we will consider its inclusion into the core library. |
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
docs/oauth2client-deprecation.rst
Outdated
| The unsupported features are: | ||
|
|
||
| #. Support for obtaining user credentials. While this library has support for using user credentials, there are no provisions in the core library for doing the three-party OAuth 2.0 flow to obtain authorization from a user. Instead, we are opting to provide a separate package that does integration with `oauthlib`_, `google-auth-oauthlib`_. When that library has a stable API, we will consider its inclusion into the core library. | ||
| #. Support for storing credentials. The only credentials type that needs to be stored are user credentials. We have a `discussion thread`_ on what level of support we should do. It’s very likely we’ll choose to provide an abstract interface for this and leave it up to application to provide storage implementation specific to their use case. It's also very likely that we will also incubate this functionality in the `google-auth-oauthlib`_ library before including it in the core library. |
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
docs/oauth2client-deprecation.rst
Outdated
| Post-deprecation support | ||
| ------------------------ | ||
|
|
||
| While ``oauth2client`` will not be implementing or accepting any new features, the ``google-auth`` team will continue to accept bug reports and fix critical bugs. We will make patch releases as necessary. We have no plans to remove the library from github or PyPI. Also, we have made sure that the `google-api-python-client`_ library supports oauth2client and google-auth and will continue to do so indefinitely. |
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
|
Thanks a ton for providing the thought process here. It helps me plan for future integration of google APIs and place bets on how best to stay in the "well-maintained" code-path. |
No description provided.