| Name | yahoo-oauth JSON |
| Version |
2.0.1
JSON |
| download |
| home_page | None |
| Summary | A very easy to use OAuth python library for Yahoo! APIs. |
| upload_time | 2024-05-17 22:08:28 |
| maintainer | None |
| docs_url | None |
| author | Josue Kouka |
| requires_python | <4.0,>=3.10 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# yahoo_oauth
[](https://travis-ci.org/josuebrunel/yahoo-oauth)
[](https://readthedocs.org/projects/yahoo-oauth/?badge=latest)
[](https://landscape.io/github/josuebrunel/yahoo-oauth/master)
[](https://pypi.python.org/pypi/yahoo_oauth)
[](https://pypi.python.org/pypi/yahoo_oauth)
[](https://pypi.python.org/pypi/yahoo_oauth)
[](https://pypi.python.org/pypi/yahoo_oauth)
[](https://coveralls.io/r/josuebrunel/yahoo-oauth?branch=master)
[](https://pypi.python.org/pypi/yahoo_oauth)
Yahoo_OAuth is a very easy to use OAuth library for Yahoo! APIs.
## Installation
```python
pip install yahoo_oauth
```
## Quickstart
Wether you use **OAuth1** or **OAuth2**, only **2** parameters are required.
* ___consumer_key___
* ___consumer_secret___
I recommend putting those two into a file. Only ***json*** and ***yaml*** files are supported
```json
{
"consumer_key": "my_very_long_and_weird_consumer_key",
"consumer_secret": "my_not_that_long_consumer_secret"
}
```
Once you acquired your access_token, this file will look like :
* **OAuth1**
```json
{
"access_token": "A=5ZnN5xXY5yKacQp1QtUF68MlEmXVIF8fRplkc7W1QMVYeLJ2DdBmNyH7SxVgUbAjdv5edCnk_DEUbfr6GpqezsSAuE9h36wfh.J45twIo1sA.bqMk7Bta6IisI9z1_h8D0QZzWYmjybxlQcuNgd7TY4nJuu_Afj_8ED787BQbjg6OqRotV.eM4_YyBCjP1K8G6rG44iX2PGNj.JSEJrocgvglABkTTVA_8t.JoLH7NHSgxCQXhakBsk3_K.6Rkgm_Nkc7.ZD02pYy3dJAfBh1fFvtrCwIOqDIplri305dZ1UY430X6SfPnZIFJNiTWkMH8_QRhcnfizG5TZugN_.0ib2VnnUzspeFT0_86p6WMP3uFOLYXspdEOryhSJwFJ3AHZN9n.t8euRQOxanpsvw5M5ffBs6P0dI5FijGw3fibbqoheJOSUE_BRUNEL_KOUKAJSsJCH(^_^)JHllHmJUptK9k5ifiqJOpTbodnW8EsyyNhthDOusv5Bp6142mvCPnC7HX7PkTodHqfgVyAUOvOqSsqMGyc65OY8roLORKpUWObw9bjd8YsU40jwSaGZtWmvVhYV9RxUA779bRuE1k0BL_fvXQ_tlZnxPhtIFBB64szQ9AwA9HT_nZKq8q1rOfUcBIZJ7Zu1jwpZUAOkHsfmHWCW2gK8BC4wjk0WuJg95FpZ2z741mhRcdma2bVYpdh3k2DdaBVYRTDT36Q4SBtreb_GNi1Mctg.RhSqopCTTvW4jjXAkt2SHnscUi37v0yo4JVex0cnVmVTFL7TRl1JMLl9jt0XmaLaKuS4nhR4A--",
"access_token_secret": "99a20a82e99THE_A_Tf803cb153f3d98",
"consumer_key": "dj0yJmk9e_THIS_IS_THE_CK_RGTnpZbWNHbzlNQS0tJnM9Y29uc3VtZXJzZWNyZXQmeD1iNQ--",
"consumer_secret": "08802b459abTHIS_IS_THE_CS4b75789f7",
"guid": "AJHDHJMYGUID",
"session_handle": "APIENFXij.bjFW_MY_SESSION_EXn.4.DOIYOR37",
"token_time": 1433546792.343515
}
```
* **OAuth2**
```json
{
"access_token": "DELvMgOYvwPQJS8eFW_2hRN5rJxz6dnHAOk2s.qB0iMIeRg5.ZpW3xZF0p8CABLjZ2gfNdE602dCN2wTHdGHHLtChF3ls9BUuZ1QDdqIVq.yWclfweleyZSq6dAzlPEHiskWmfItjHK5VERY_LONG_ACCESS_TOKEN_oyyD4cIKvdNJsJ9k779mAUqN02_5ugBeDfCLebqjL8uVuunObew0ERa2MxE6jywNY0TTCe9W0nqTd6n0lKoN4PSP1Dw_Ifwx6enGuhUUAhhpa7nNMyhNy_pe6PfDf7IJ5gbkdtw3mD1o2T218ZTV0owdrKDLSF9oZrNvZ75xDlqaaI5yeW_.L63zk11PjsWUd5K8LGhWSTgRbyhffCDBcqVwTYEqHwCyVqHX4z2kgHhGsc0ies6WMG33kSw5Cgun0fnPbdDuHBgQziXU.GMv4hIDoIDMSLGpzpcpkyx4GS1CC_RUQwKxLilR3MQy7X2gI3cJA4lhRPlXEOdhS5HIQiQTgMWO9nWt7.RR7XtXVg-",
"consumer_key": "dj0yJmk9eFJINERDYWMY_CONSUMER_KEYmRGTnpZbWNHbzlNQS0tJnM9Y29uc3VtZXJzZWNyZXQmeD1iNQ--",
"consumer_secret": "08802b459ab48eeaMY_CONSUMER_SECRET_0af6a4b75789f7",
"guid": "AJHDHJMYGUID",
"refresh_token": "APIENFXij.bjFW1tEcr2THE_REFRESH_TOKEN_Xn.4.DOIYOR37",
"token_time": 1433553339.706037,
"token_type": "bearer"
}
```
With that you should be good to go.
Normally, once your got all that, you can ***use the same credentials FOREVER***, you just have to ***REFRESH THEM***.
## Examples
### OAuth1
```python
from yahoo_oauth import OAuth1
oauth = OAuth1(None, None, from_file='oauth1.json')
...
if not oauth.token_is_valid():
oauth.refresh_access_token()
# Example
response = oauth.session.post(url, data=body)
```
### OAuth2
```python
from yahoo_oauth import OAuth2
oauth = OAuth2(None, None, from_file='oauth2.json')
...
if not oauth.token_is_valid():
oauth.refresh_access_token()
# Example
response = oauth.session.get(url, params=payload)
```
### Tips
* How to get your Global Unique Identifier (GUID)
```python
from yahoo_oauth import OAuth2
oauth = OAuth2('consumer_key', 'consumer_secret')
guid = oauth.guid
```
* How to disable **Yahoo_OAuth Logger**
```python
import logging
oauth_logger = logging.getLogger('yahoo_oauth')
oauth_logger.disabled = True
```
## Contribute
Any kind of contribution is welcomed.
0. report bug by opening an issue
1. Fork the repository
2. Make your changes
3. Test your changes
4. Submit a pull request
Have fun guys :wink:
Raw data
{
"_id": null,
"home_page": null,
"name": "yahoo-oauth",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Josue Kouka",
"author_email": "josuebrunel@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/12/56/0636a606172fb90c935a1befe90e29159a590a6bba85db616637c619f115/yahoo_oauth-2.0.1.tar.gz",
"platform": null,
"description": "# yahoo_oauth\n\n[](https://travis-ci.org/josuebrunel/yahoo-oauth)\n[](https://readthedocs.org/projects/yahoo-oauth/?badge=latest)\n[](https://landscape.io/github/josuebrunel/yahoo-oauth/master)\n[](https://pypi.python.org/pypi/yahoo_oauth)\n[](https://pypi.python.org/pypi/yahoo_oauth)\n[](https://pypi.python.org/pypi/yahoo_oauth)\n[](https://pypi.python.org/pypi/yahoo_oauth)\n[](https://coveralls.io/r/josuebrunel/yahoo-oauth?branch=master)\n[](https://pypi.python.org/pypi/yahoo_oauth)\n\nYahoo_OAuth is a very easy to use OAuth library for Yahoo! APIs. \n\n## Installation\n\n```python\npip install yahoo_oauth\n```\n\n## Quickstart\n\nWether you use **OAuth1** or **OAuth2**, only **2** parameters are required.\n\n* ___consumer_key___ \n* ___consumer_secret___\n\nI recommend putting those two into a file. Only ***json*** and ***yaml*** files are supported \n\n```json\n{\n \"consumer_key\": \"my_very_long_and_weird_consumer_key\",\n \"consumer_secret\": \"my_not_that_long_consumer_secret\"\n}\n```\n\nOnce you acquired your access_token, this file will look like :\n\n* **OAuth1**\n\n```json\n{\n \"access_token\": \"A=5ZnN5xXY5yKacQp1QtUF68MlEmXVIF8fRplkc7W1QMVYeLJ2DdBmNyH7SxVgUbAjdv5edCnk_DEUbfr6GpqezsSAuE9h36wfh.J45twIo1sA.bqMk7Bta6IisI9z1_h8D0QZzWYmjybxlQcuNgd7TY4nJuu_Afj_8ED787BQbjg6OqRotV.eM4_YyBCjP1K8G6rG44iX2PGNj.JSEJrocgvglABkTTVA_8t.JoLH7NHSgxCQXhakBsk3_K.6Rkgm_Nkc7.ZD02pYy3dJAfBh1fFvtrCwIOqDIplri305dZ1UY430X6SfPnZIFJNiTWkMH8_QRhcnfizG5TZugN_.0ib2VnnUzspeFT0_86p6WMP3uFOLYXspdEOryhSJwFJ3AHZN9n.t8euRQOxanpsvw5M5ffBs6P0dI5FijGw3fibbqoheJOSUE_BRUNEL_KOUKAJSsJCH(^_^)JHllHmJUptK9k5ifiqJOpTbodnW8EsyyNhthDOusv5Bp6142mvCPnC7HX7PkTodHqfgVyAUOvOqSsqMGyc65OY8roLORKpUWObw9bjd8YsU40jwSaGZtWmvVhYV9RxUA779bRuE1k0BL_fvXQ_tlZnxPhtIFBB64szQ9AwA9HT_nZKq8q1rOfUcBIZJ7Zu1jwpZUAOkHsfmHWCW2gK8BC4wjk0WuJg95FpZ2z741mhRcdma2bVYpdh3k2DdaBVYRTDT36Q4SBtreb_GNi1Mctg.RhSqopCTTvW4jjXAkt2SHnscUi37v0yo4JVex0cnVmVTFL7TRl1JMLl9jt0XmaLaKuS4nhR4A--\", \n \"access_token_secret\": \"99a20a82e99THE_A_Tf803cb153f3d98\", \n \"consumer_key\": \"dj0yJmk9e_THIS_IS_THE_CK_RGTnpZbWNHbzlNQS0tJnM9Y29uc3VtZXJzZWNyZXQmeD1iNQ--\", \n \"consumer_secret\": \"08802b459abTHIS_IS_THE_CS4b75789f7\", \n \"guid\": \"AJHDHJMYGUID\",\n \"session_handle\": \"APIENFXij.bjFW_MY_SESSION_EXn.4.DOIYOR37\", \n \"token_time\": 1433546792.343515\n}\n```\n\n* **OAuth2**\n\n```json\n{\n \"access_token\": \"DELvMgOYvwPQJS8eFW_2hRN5rJxz6dnHAOk2s.qB0iMIeRg5.ZpW3xZF0p8CABLjZ2gfNdE602dCN2wTHdGHHLtChF3ls9BUuZ1QDdqIVq.yWclfweleyZSq6dAzlPEHiskWmfItjHK5VERY_LONG_ACCESS_TOKEN_oyyD4cIKvdNJsJ9k779mAUqN02_5ugBeDfCLebqjL8uVuunObew0ERa2MxE6jywNY0TTCe9W0nqTd6n0lKoN4PSP1Dw_Ifwx6enGuhUUAhhpa7nNMyhNy_pe6PfDf7IJ5gbkdtw3mD1o2T218ZTV0owdrKDLSF9oZrNvZ75xDlqaaI5yeW_.L63zk11PjsWUd5K8LGhWSTgRbyhffCDBcqVwTYEqHwCyVqHX4z2kgHhGsc0ies6WMG33kSw5Cgun0fnPbdDuHBgQziXU.GMv4hIDoIDMSLGpzpcpkyx4GS1CC_RUQwKxLilR3MQy7X2gI3cJA4lhRPlXEOdhS5HIQiQTgMWO9nWt7.RR7XtXVg-\",\n \"consumer_key\": \"dj0yJmk9eFJINERDYWMY_CONSUMER_KEYmRGTnpZbWNHbzlNQS0tJnM9Y29uc3VtZXJzZWNyZXQmeD1iNQ--\",\n \"consumer_secret\": \"08802b459ab48eeaMY_CONSUMER_SECRET_0af6a4b75789f7\",\n \"guid\": \"AJHDHJMYGUID\",\n \"refresh_token\": \"APIENFXij.bjFW1tEcr2THE_REFRESH_TOKEN_Xn.4.DOIYOR37\",\n \"token_time\": 1433553339.706037,\n \"token_type\": \"bearer\"\n}\n```\n\nWith that you should be good to go.\n\nNormally, once your got all that, you can ***use the same credentials FOREVER***, you just have to ***REFRESH THEM***. \n\n## Examples\n\n### OAuth1\n\n```python\nfrom yahoo_oauth import OAuth1\noauth = OAuth1(None, None, from_file='oauth1.json')\n...\n\nif not oauth.token_is_valid():\n oauth.refresh_access_token()\n\n# Example\nresponse = oauth.session.post(url, data=body)\n```\n\n### OAuth2\n\n```python\nfrom yahoo_oauth import OAuth2\noauth = OAuth2(None, None, from_file='oauth2.json')\n...\n\nif not oauth.token_is_valid():\n oauth.refresh_access_token()\n# Example\nresponse = oauth.session.get(url, params=payload)\n```\n\n### Tips\n\n* How to get your Global Unique Identifier (GUID)\n```python\nfrom yahoo_oauth import OAuth2\n\noauth = OAuth2('consumer_key', 'consumer_secret')\nguid = oauth.guid\n\n```\n\n* How to disable **Yahoo_OAuth Logger**\n```python\nimport logging\noauth_logger = logging.getLogger('yahoo_oauth')\noauth_logger.disabled = True\n```\n\n## Contribute\n\nAny kind of contribution is welcomed.\n\n0. report bug by opening an issue\n1. Fork the repository\n2. Make your changes\n3. Test your changes\n4. Submit a pull request\n\nHave fun guys :wink:\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A very easy to use OAuth python library for Yahoo! APIs.",
"version": "2.0.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9b4e7e217e7b41b639111c38ef36fd945ed755c8c7930690abfec526e383a02b",
"md5": "6258da76ccaeebc99a7c36227bc90fb2",
"sha256": "d47ac1779e730b27286805cb87080f32841a74bc2df9f7ffa2456554fb8ba5e3"
},
"downloads": -1,
"filename": "yahoo_oauth-2.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6258da76ccaeebc99a7c36227bc90fb2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 7762,
"upload_time": "2024-05-17T22:08:26",
"upload_time_iso_8601": "2024-05-17T22:08:26.784809Z",
"url": "https://files.pythonhosted.org/packages/9b/4e/7e217e7b41b639111c38ef36fd945ed755c8c7930690abfec526e383a02b/yahoo_oauth-2.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "12560636a606172fb90c935a1befe90e29159a590a6bba85db616637c619f115",
"md5": "7ee70adca487582619ca7ea612ca316c",
"sha256": "115a8cbce04f2b15db08b8d5be033eb09286882f7cf8f7b9fb7aa52f6ac10018"
},
"downloads": -1,
"filename": "yahoo_oauth-2.0.1.tar.gz",
"has_sig": false,
"md5_digest": "7ee70adca487582619ca7ea612ca316c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 6847,
"upload_time": "2024-05-17T22:08:28",
"upload_time_iso_8601": "2024-05-17T22:08:28.505269Z",
"url": "https://files.pythonhosted.org/packages/12/56/0636a606172fb90c935a1befe90e29159a590a6bba85db616637c619f115/yahoo_oauth-2.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-17 22:08:28",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "yahoo-oauth"
}
