Merge pull request #140 from MerleLiuKun/feat-client

Feat client

Author: MerleLiuKun

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file.
 
+## Version 0.9.0 (in development)
+
+### What's New
+
+- Introduce new `Client` to operate YouTube DATA API. [#120](https://github.com/sns-sdks/python-youtube/issues/120).
+
 ## Version 0.8.3 (2022-10-17)
 
 ### What's New

docs/docs/authorization.md

@@ -30,11 +30,11 @@ Now we can begin do the follows step.
 Initialize the api instance with you app credentials
 
 ```
-In [1]: from pyyoutube import Api
+In [1]: from pyyoutube import Client
 
-In [2]: api = Api(client_id="you client id", client_secret="you client secret")
+In [2]: cli = Client(client_id="you client id", client_secret="you client secret")
 
-In [3]: api.get_authorization_url()
+In [3]: cli.get_authorize_url()
 Out[3]:
 ('https://accounts.google.com/o/oauth2/v2/auth?response_type=code&client_id=client_id&redirect_uri=https%3A%2F%2Flocalhost%2F&scope=https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fyoutube+https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fuserinfo.profile&state=PyYouTube&access_type=offline&prompt=select_account',
  'PyYouTube')
@@ -72,7 +72,7 @@ Then you will get a Connection Error, don't worry. This just because we set the
 Now you need to copy the full url in the browser address bar. Then back to you console.
 
 ```
-In [4]: token = api.generate_access_token(authorization_response="the whole url")
+In [4]: token = cli.generate_access_token(authorization_response="the whole url")
 
 In [5]: token
 Out[5]: AccessToken(access_token='access token', expires_in=3600, token_type='Bearer')
@@ -87,23 +87,14 @@ now you have got your access token to visit your self data.
 For example, you can get your playlists.
 
 ```
-In [6]: playlists = api.get_playlists(mine=True)
+In [6]: playlists = cli.playlists.list(mine=True)
 
 In [7]: playlists.items
 Out[7]:
 [Playlist(kind='youtube#playlist', id='PLBaidt0ilCManGDIKr8UVBFZwN_UvMKvS'),
  Playlist(kind='youtube#playlist', id='PLBaidt0ilCMbUdj0EppB710c_X5OuCP2g')]
 ```
 
-get your self profile.
-
-```
-In [8]: profile = api.get_profile()
-
-In [9]: profile
-Out[9]: UserProfile(id='110109920178558006671', name='ikaros-life')
-```
-
 !!! note "Tips"
 
-    If you have some confuse. you need to read the [Authorize Requests](https://developers.google.com/youtube/v3/guides/authentication) first.
+    If you have some confuse. you need to read the [Authorize Requests](https://developers.google.com/youtube/v3/guides/authentication) first.

docs/docs/getting_started.md

@@ -54,9 +54,10 @@ Now you have generated one api key.
 
 Use this key. You can retrieve public data for YouTube data by our library
 
-```pythonregexp
-In [1]: import pyyoutube
-In [2]: api = pyyoutube.Api(api_key='your api key')
+```python
+from pyyoutube import Client
+
+cli = Client(api_key="your api key")
 ```
 
 If you want to get some examples to see, check out the [examples](https://github.com/sns-sdks/python-youtube/tree/master/examples).