Skip to content

Commit

Permalink
Merge pull request #50 from robert-mings/master
Browse files Browse the repository at this point in the history
chore: update readme, docs + general cleanup
  • Loading branch information
robert-mings authored Jul 31, 2024
2 parents 451deee + bec9ce4 commit 4c44f91
Show file tree
Hide file tree
Showing 5 changed files with 41 additions and 35 deletions.
41 changes: 21 additions & 20 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@
.. image:: views/SDK.png
:target: https://help.developer.intuit.com/s/samplefeedback?cid=1110&repoName=oauth-pythonclient

Intuit's OAuth2 and OpenID Python Client
Intuit's OAuth2 and OpenID Connect Python Client
========================================

|build| |coverage| |docs|

.. |build| image:: https://travis-ci.com/intuit/oauth-pythonclient.svg?branch=master
:target: https://travis-ci.com/intuit/oauth-pythonclient
|coverage| |docs|

.. |coverage| image:: https://coveralls.io/repos/github/intuit/oauth-pythonclient/badge.svg?branch=master
:target: https://coveralls.io/github/intuit/oauth-pythonclient?branch=master
Expand All @@ -16,14 +10,21 @@ Intuit's OAuth2 and OpenID Python Client
:target: https://oauth-pythonclient.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

This client library is meant to work with Intuit's OAuth and OpenID implementation. The `AuthClient` object response can be used for User Info API, Accounting API and Payments API. This library supports:

- Generating Authorization URL
- Getting OAuth2 Bearer Token
- Getting User Info
- Validating OpenID token
- Refreshing OAuth2 Token
- Revoking OAuth2 Token
The official Python client library for working with Intuit APIs.
The `AuthClient` object response can be used for the
`Intuit UserInfo API <https://developer.intuit.com/app/developer/qbo/docs/develop/authentication-and-authorization/openid-connect#obtaining-user-profile-information>`_,
`QuickBooks Accounting API <https://developer.intuit.com/app/developer/qbo/docs/learn/explore-the-quickbooks-online-api>`_,
and `QuickBooks Payments API <https://developer.intuit.com/app/developer/qbpayments/docs/learn/explore-the-quickbooks-payments-api>`_.

This library supports:

- Raising authorization requests
- Requesting OAuth2 bearer (access) tokens
- Refreshing OAuth2 tokens
- Revoking OAuth2 tokens
- Validating ID tokens
- Fetching profile attributes from UserInfo
- Various utility methods
- Migrating tokens from OAuth1.0 to OAuth2

Install
Expand All @@ -36,19 +37,19 @@ Using `pip <https://pypi.org/project/pip/>`_: ::
Documentation
-------------

Usage and Reference Documentation can be found at `oauth-pythonclient.readthedocs.io <https://oauth-pythonclient.readthedocs.io/en/latest/>`_
Usage and reference documentation can be found at `oauth-pythonclient.readthedocs.io <https://oauth-pythonclient.readthedocs.io/en/latest/>`_.

Sample App
----------

Sample app for this library can be found at `IntuitDeveloper GitHub Org <https://github.com/IntuitDeveloper/SampleOAuth2_UsingPythonClient>`_
A sample app for this library can be found on the `IntuitDeveloper GitHub Org <https://github.com/IntuitDeveloper/SampleOAuth2_UsingPythonClient>`_.

Issues and Contributions
------------------------

Please open an `issue <https://github.com/intuit/oauth-pythonclient/issues>`_ on GitHub if you have a problem, suggestion, or other comment.
Please open an `issue <https://github.com/intuit/oauth-pythonclient/issues>`_ on GitHub if you have anything to report, a suggestion, or comment.

Pull requests are welcome and encouraged! Any contributions should include new or updated unit tests as necessary to maintain thorough test coverage.
Pull requests are welcomed and encouraged! Any contributions should include new or updated unit tests as necessary to maintain thorough test coverage.

License
-------
Expand Down
31 changes: 18 additions & 13 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,29 +3,34 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Intuit's OAuth2 and OpenID Client
Intuit's OAuth2 and OpenID Connect Client
=================================

`View on GitHub <https://github.com/intuit/oauth-pythonclient>`_

This client library is meant to work with Intuit's OAuth and OpenID implementation. The `bearer_token` response can be used for User Info API, Accounting API and Payments API. It supports:

- Generating Authorization URL
- Getting OAuth2 Bearer Token
- Getting User Info
- Validating OpenID token
- Refreshing OAuth2 Token
- Revoking OAuth2 Token
The official Python client library for working with Intuit APIs.
The `AuthClient` object response can be used for the
`Intuit UserInfo API <https://developer.intuit.com/app/developer/qbo/docs/develop/authentication-and-authorization/openid-connect#obtaining-user-profile-information>`_,
`QuickBooks Accounting API <https://developer.intuit.com/app/developer/qbo/docs/learn/explore-the-quickbooks-online-api>`_,
and `QuickBooks Payments API <https://developer.intuit.com/app/developer/qbpayments/docs/learn/explore-the-quickbooks-payments-api>`_.

This library supports:

- Raising authorization requests
- Requesting OAuth2 bearer (access) tokens
- Refreshing OAuth2 tokens
- Revoking OAuth2 tokens
- Validating ID tokens
- Fetching profile attributes from UserInfo
- Various utility methods
- Migrating tokens from OAuth1.0 to OAuth2

`View this library on GitHub <https://github.com/intuit/oauth-pythonclient>`_

Install Client
--------------
This library can be installed using `pip <https://pypi.org/project/pip/>`_::

$ pip install intuit-oauth

View it on GitHub `here <https://github.com/intuit/oauth-pythonclient>`_

Docs
----

Expand Down
2 changes: 1 addition & 1 deletion intuitlib/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
import requests
import six
import string
from base64 import b64encode, b64decode, urlsafe_b64decode
from base64 import b64encode, b64decode
from datetime import datetime
from requests.sessions import Session

Expand Down
2 changes: 1 addition & 1 deletion intuitlib/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@
# See the License for the specific language governing permissions and
# limitations under the License.

__version__ = '1.2.5'
__version__ = '1.2.6'
Binary file removed views/SDK.png
Binary file not shown.

0 comments on commit 4c44f91

Please sign in to comment.