Metadata-Version: 1.1
Name: annict
Version: 0.5.2
Summary: Annict API for Python
Home-page: https://github.com/kk6/python-annict
Author: kk6
Author-email: hiro.ashiya@gmail.com
License: MIT
Description: python-annict
        =============
        
        Annict API wrapper for python
        
        |CircleCI|
        
        python-annict は Python3.6 以上をサポートしています。
        
        インストール
        ------------
        
        使い方
        ------
        
        認証
        ~~~~
        
        認証コード取得用のURLを生成
        
        .. code:: python
        
            >>> from annict.auth import OAuthHandler
            >>> handler = OAuthHandler(client_id='Your client ID', client_secret='Your client secret')
            >>> url = handler.get_authorization_url(scope='read write')
            >>> print(url)
        
        URLをブラウザで開いて認証コードを表示します。それを
        ``handler.authenticate()`` の引数に渡してアクセストークンを取得します。
        
        .. code:: python
        
            >>> handler.authenticate(code='Authentication code')
            >>> print(handler.get_access_token())
        
        なお、Annict上で個人用アクセストークンを発行しそれを使用する場合はこの認証フローは不要です。
        
        参照： `Annict API:
        個人用アクセストークンが発行できるようになりました <http://blog.annict.com/post/157138114218/personal-access-token>`__
        
        API
        ~~~
        
        .. code:: python
        
            >>> from annict.api import API
            >>> annict = API('Your access token')
            >>> results = annict.works(filter_title="Re:ゼロから始める異世界生活")
            >>> print(results[0].title)
            Re:ゼロから始める異世界生活
        
        キャッシュ
        ~~~~~~~~~~
        
        独自のキャッシュシステムは実装していませんが、\ `requests\_cache <https://github.com/reclosedev/requests-cache>`__
        というrequests用キャッシュプラグインとの併用を強くおすすめします。
        
        使用例
        ''''''
        
        .. code:: python
        
            >>> import requests_cache
            >>> # 有効期限300秒でメモリにキャッシュするよう設定
            >>> requests_cache.install_cache(cache_name='annict', backend='memory', expire_after=300)
            >>> # 最初のリクエストはAPIから
            >>> api.me()
            >>> # 300秒以内の同一リクエストはキャッシュから
            >>> api.me()
        
        さらに詳しい使い方は `Requests-cache
        公式ドキュメント <https://requests-cache.readthedocs.io/en/latest/>`__
        を参照してください。
        
        .. |CircleCI| image:: https://circleci.com/gh/kk6/python-annict.svg?style=svg
           :target: https://circleci.com/gh/kk6/python-annict
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries
