yahoo-oauth


Nameyahoo-oauth JSON
Version 2.1.1 PyPI version JSON
download
home_pageNone
SummaryA very easy to use OAuth python library for Yahoo! APIs.
upload_time2024-12-17 17:30:03
maintainerNone
docs_urlNone
authorJosue Kouka
requires_python<4.0,>=3.10
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # yahoo_oauth

[![Build Status](https://travis-ci.org/josuebrunel/yahoo-oauth.svg?branch=master)](https://travis-ci.org/josuebrunel/yahoo-oauth)
[![Documentation Status](https://readthedocs.org/projects/yahoo-oauth/badge/?version=latest)](https://readthedocs.org/projects/yahoo-oauth/?badge=latest)
[![Code Health](https://landscape.io/github/josuebrunel/yahoo-oauth/master/landscape.svg?style=flat)](https://landscape.io/github/josuebrunel/yahoo-oauth/master)
[![PyPI](https://img.shields.io/pypi/v/yahoo-oauth.svg?style=flat)](https://pypi.python.org/pypi/yahoo_oauth)
[![PyPI](https://img.shields.io/pypi/dm/yahoo-oauth.svg?style=flat)](https://pypi.python.org/pypi/yahoo_oauth)
[![PyPI](https://img.shields.io/pypi/pyversions/yahoo-oauth.svg?style=flat)](https://pypi.python.org/pypi/yahoo_oauth)
[![PyPI](https://img.shields.io/pypi/implementation/yahoo-oauth.svg?style=flat)](https://pypi.python.org/pypi/yahoo_oauth)
[![Coverage Status](https://coveralls.io/repos/josuebrunel/yahoo-oauth/badge.svg?branch=master)](https://coveralls.io/r/josuebrunel/yahoo-oauth?branch=master)
[![PyPI](https://img.shields.io/pypi/l/yahoo-oauth.svg?style=flat)](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

Only **2** parameters are required to get started

* ___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 :

* **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",
    "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

### 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 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/4c/d0/e8d15da20b015926e67208eac75718ded18532cd12ce4813ddbcf1186820/yahoo_oauth-2.1.1.tar.gz",
    "platform": null,
    "description": "# yahoo_oauth\n\n[![Build Status](https://travis-ci.org/josuebrunel/yahoo-oauth.svg?branch=master)](https://travis-ci.org/josuebrunel/yahoo-oauth)\n[![Documentation Status](https://readthedocs.org/projects/yahoo-oauth/badge/?version=latest)](https://readthedocs.org/projects/yahoo-oauth/?badge=latest)\n[![Code Health](https://landscape.io/github/josuebrunel/yahoo-oauth/master/landscape.svg?style=flat)](https://landscape.io/github/josuebrunel/yahoo-oauth/master)\n[![PyPI](https://img.shields.io/pypi/v/yahoo-oauth.svg?style=flat)](https://pypi.python.org/pypi/yahoo_oauth)\n[![PyPI](https://img.shields.io/pypi/dm/yahoo-oauth.svg?style=flat)](https://pypi.python.org/pypi/yahoo_oauth)\n[![PyPI](https://img.shields.io/pypi/pyversions/yahoo-oauth.svg?style=flat)](https://pypi.python.org/pypi/yahoo_oauth)\n[![PyPI](https://img.shields.io/pypi/implementation/yahoo-oauth.svg?style=flat)](https://pypi.python.org/pypi/yahoo_oauth)\n[![Coverage Status](https://coveralls.io/repos/josuebrunel/yahoo-oauth/badge.svg?branch=master)](https://coveralls.io/r/josuebrunel/yahoo-oauth?branch=master)\n[![PyPI](https://img.shields.io/pypi/l/yahoo-oauth.svg?style=flat)](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\nOnly **2** parameters are required to get started\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* **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    \"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### 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 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.1.1",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b057aa73e93b6e75a67e120795a703fe0e4b0cae5d83c18a7fc646aa21f395f6",
                "md5": "8e1d062a5644fd6cc7e74d136775a50f",
                "sha256": "bacd876298d933c57d230893aaf8f1cb70f3306cc0ffda50c3b511ec3a06a8e2"
            },
            "downloads": -1,
            "filename": "yahoo_oauth-2.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8e1d062a5644fd6cc7e74d136775a50f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 6499,
            "upload_time": "2024-12-17T17:30:02",
            "upload_time_iso_8601": "2024-12-17T17:30:02.568604Z",
            "url": "https://files.pythonhosted.org/packages/b0/57/aa73e93b6e75a67e120795a703fe0e4b0cae5d83c18a7fc646aa21f395f6/yahoo_oauth-2.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4cd0e8d15da20b015926e67208eac75718ded18532cd12ce4813ddbcf1186820",
                "md5": "134d4ce697ad1bbd2396431ede9d6f47",
                "sha256": "9d10452ad705e44f2b4adc64ddf01f9e97e1cbc5bf2fac1d9f7d6de2c2ae73d6"
            },
            "downloads": -1,
            "filename": "yahoo_oauth-2.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "134d4ce697ad1bbd2396431ede9d6f47",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.10",
            "size": 5528,
            "upload_time": "2024-12-17T17:30:03",
            "upload_time_iso_8601": "2024-12-17T17:30:03.606182Z",
            "url": "https://files.pythonhosted.org/packages/4c/d0/e8d15da20b015926e67208eac75718ded18532cd12ce4813ddbcf1186820/yahoo_oauth-2.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-17 17:30:03",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "yahoo-oauth"
}
        
Elapsed time: 0.37458s