Skip to content

Commit bec9ce4

Browse files
committed
chore: update readme, docs + general cleanup
1 parent 451deee commit bec9ce4

File tree

5 files changed

+41
-35
lines changed

5 files changed

+41
-35
lines changed

README.rst

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,7 @@
1-
.. image:: views/SDK.png
2-
:target: https://help.developer.intuit.com/s/samplefeedback?cid=1110&repoName=oauth-pythonclient
3-
4-
Intuit's OAuth2 and OpenID Python Client
1+
Intuit's OAuth2 and OpenID Connect Python Client
52
========================================
63

7-
|build| |coverage| |docs|
8-
9-
.. |build| image:: https://travis-ci.com/intuit/oauth-pythonclient.svg?branch=master
10-
:target: https://travis-ci.com/intuit/oauth-pythonclient
4+
|coverage| |docs|
115

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

19-
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:
20-
21-
- Generating Authorization URL
22-
- Getting OAuth2 Bearer Token
23-
- Getting User Info
24-
- Validating OpenID token
25-
- Refreshing OAuth2 Token
26-
- Revoking OAuth2 Token
13+
The official Python client library for working with Intuit APIs.
14+
The `AuthClient` object response can be used for the
15+
`Intuit UserInfo API <https://developer.intuit.com/app/developer/qbo/docs/develop/authentication-and-authorization/openid-connect#obtaining-user-profile-information>`_,
16+
`QuickBooks Accounting API <https://developer.intuit.com/app/developer/qbo/docs/learn/explore-the-quickbooks-online-api>`_,
17+
and `QuickBooks Payments API <https://developer.intuit.com/app/developer/qbpayments/docs/learn/explore-the-quickbooks-payments-api>`_.
18+
19+
This library supports:
20+
21+
- Raising authorization requests
22+
- Requesting OAuth2 bearer (access) tokens
23+
- Refreshing OAuth2 tokens
24+
- Revoking OAuth2 tokens
25+
- Validating ID tokens
26+
- Fetching profile attributes from UserInfo
27+
- Various utility methods
2728
- Migrating tokens from OAuth1.0 to OAuth2
2829

2930
Install
@@ -36,19 +37,19 @@ Using `pip <https://pypi.org/project/pip/>`_: ::
3637
Documentation
3738
-------------
3839

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

4142
Sample App
4243
----------
4344

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

4647
Issues and Contributions
4748
------------------------
4849

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

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

5354
License
5455
-------

docs/index.rst

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,29 +3,34 @@
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
Intuit's OAuth2 and OpenID Client
6+
Intuit's OAuth2 and OpenID Connect Client
77
=================================
88

9-
`View on GitHub <https://github.com/intuit/oauth-pythonclient>`_
10-
11-
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:
12-
13-
- Generating Authorization URL
14-
- Getting OAuth2 Bearer Token
15-
- Getting User Info
16-
- Validating OpenID token
17-
- Refreshing OAuth2 Token
18-
- Revoking OAuth2 Token
9+
The official Python client library for working with Intuit APIs.
10+
The `AuthClient` object response can be used for the
11+
`Intuit UserInfo API <https://developer.intuit.com/app/developer/qbo/docs/develop/authentication-and-authorization/openid-connect#obtaining-user-profile-information>`_,
12+
`QuickBooks Accounting API <https://developer.intuit.com/app/developer/qbo/docs/learn/explore-the-quickbooks-online-api>`_,
13+
and `QuickBooks Payments API <https://developer.intuit.com/app/developer/qbpayments/docs/learn/explore-the-quickbooks-payments-api>`_.
14+
15+
This library supports:
16+
17+
- Raising authorization requests
18+
- Requesting OAuth2 bearer (access) tokens
19+
- Refreshing OAuth2 tokens
20+
- Revoking OAuth2 tokens
21+
- Validating ID tokens
22+
- Fetching profile attributes from UserInfo
23+
- Various utility methods
1924
- Migrating tokens from OAuth1.0 to OAuth2
2025

26+
`View this library on GitHub <https://github.com/intuit/oauth-pythonclient>`_
27+
2128
Install Client
2229
--------------
2330
This library can be installed using `pip <https://pypi.org/project/pip/>`_::
2431

2532
$ pip install intuit-oauth
2633

27-
View it on GitHub `here <https://github.com/intuit/oauth-pythonclient>`_
28-
2934
Docs
3035
----
3136

intuitlib/utils.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
import requests
2222
import six
2323
import string
24-
from base64 import b64encode, b64decode, urlsafe_b64decode
24+
from base64 import b64encode, b64decode
2525
from datetime import datetime
2626
from requests.sessions import Session
2727

intuitlib/version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15-
__version__ = '1.2.5'
15+
__version__ = '1.2.6'

views/SDK.png

-15.2 KB
Binary file not shown.

0 commit comments

Comments
 (0)