yahoo\_oauth
============
|Build Status| |Documentation Status|
Yahoo\_OAuth is a very easy to use OAuth python library for Yahoo! APIs.
Installation
------------
.. code:: 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
.. code:: 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**
.. code:: 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",
"session_handle": "APIENFXij.bjFW_MY_SESSION_EXn.4.DOIYOR37",
"token_time": 1433546792.343515
}
- **OAuth2**
.. code:: 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",
"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***.
OAuth1
~~~~~~
.. code:: 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
~~~~~~
.. code:: 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)
.. |Build Status| image:: https://travis-ci.org/josuebrunel/yahoo-oauth.svg?branch=master
:target: https://travis-ci.org/josuebrunel/yahoo-oauth
.. |Documentation Status| image:: https://readthedocs.org/projects/yahoo-oauth/badge/?version=latest
:target: https://readthedocs.org/projects/yahoo-oauth/?badge=latest
Raw data
{
"_id": null,
"home_page": "https://github.com/josuebrunel/yahoo-oauth",
"name": "yahoo-oauth",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "yahoo,oauth,oauth1,oauth2",
"author": "Josue Kouka",
"author_email": "josuebrunel@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/52/76/9939f6f2333f0d5413693ae8cf8db05a61be3f35c014fc727b82296784a8/yahoo_oauth-2.0.tar.gz",
"platform": "Any",
"description": "yahoo\\_oauth\n============\n\n|Build Status| |Documentation Status|\n\nYahoo\\_OAuth is a very easy to use OAuth python library for Yahoo! APIs.\n\nInstallation\n------------\n\n.. code:: python\n\n pip install yahoo_oauth\n\nQuickstart\n----------\n\nWether you use **OAuth1** or **OAuth2**, only **2** parameters are\nrequired.\n\n- ***consumer*\\ key**\\ \\_\n- ***consumer*\\ secret**\\ \\_\n\nI recommend putting those two into a file. Only ***json*** and ***yaml*** files are\nsupported\n\n.. code:: json\n\n {\n \"consumer_key\": \"my_very_long_and_weird_consumer_key\",\n \"consumer_secret\": \"my_not_that_long_consumer_secret\"\n }\n\nOnce you acquired your access\\_token, this file will look like :\n\n- **OAuth1**\n\n.. code:: json\n\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 \"session_handle\": \"APIENFXij.bjFW_MY_SESSION_EXn.4.DOIYOR37\", \n \"token_time\": 1433546792.343515\n }\n\n- **OAuth2**\n\n.. code:: json\n\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 \"refresh_token\": \"APIENFXij.bjFW1tEcr2THE_REFRESH_TOKEN_Xn.4.DOIYOR37\",\n \"token_time\": 1433553339.706037,\n \"token_type\": \"bearer\"\n }\n\nWith that you should be good to go.\n\nNormally, once your got all that, you can ***use the same credentials\nFOREVER***, you just have to ***REFRESH THEM***.\n\nOAuth1\n~~~~~~\n\n.. code:: python\n\n from yahoo_oauth import OAuth1\n oauth = OAuth1(None, None, from_file='oauth1.json')\n ...\n\n if not oauth.token_is_valid():\n oauth.refresh_access_token()\n\n # Example\n response = oauth.session.post(url, data=body)\n\nOAuth2\n~~~~~~\n\n.. code:: python\n\n from yahoo_oauth import OAuth2\n oauth = OAuth2(None, None, from_file='oauth2.json')\n ...\n\n if not oauth.token_is_valid():\n oauth.refresh_access_token()\n # Example\n response = oauth.session.get(url, params=payload)\n\n.. |Build Status| image:: https://travis-ci.org/josuebrunel/yahoo-oauth.svg?branch=master\n :target: https://travis-ci.org/josuebrunel/yahoo-oauth\n.. |Documentation Status| image:: https://readthedocs.org/projects/yahoo-oauth/badge/?version=latest\n :target: https://readthedocs.org/projects/yahoo-oauth/?badge=latest\n\n\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python Yahoo OAuth Library. Supports OAuth1 and OAuth2",
"version": "2.0",
"project_urls": {
"Download": "https://github.com/josuebrunel/yahoo-oauth/archive/2.0.tar.gz",
"Homepage": "https://github.com/josuebrunel/yahoo-oauth"
},
"split_keywords": [
"yahoo",
"oauth",
"oauth1",
"oauth2"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "52769939f6f2333f0d5413693ae8cf8db05a61be3f35c014fc727b82296784a8",
"md5": "3652b0bd8f643dedb605e14a95dab1b2",
"sha256": "912921bf8724ced6e5d7924308b2b15c2b51e14ed7d25c9c42cb8b52e3e75158"
},
"downloads": -1,
"filename": "yahoo_oauth-2.0.tar.gz",
"has_sig": false,
"md5_digest": "3652b0bd8f643dedb605e14a95dab1b2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10208,
"upload_time": "2022-10-04T14:57:46",
"upload_time_iso_8601": "2022-10-04T14:57:46.379552Z",
"url": "https://files.pythonhosted.org/packages/52/76/9939f6f2333f0d5413693ae8cf8db05a61be3f35c014fc727b82296784a8/yahoo_oauth-2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-10-04 14:57:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "josuebrunel",
"github_project": "yahoo-oauth",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"requirements": [],
"tox": true,
"lcname": "yahoo-oauth"
}
JSON
