{ "info": { "author": "kk6", "author_email": "hiro.ashiya@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Topic :: Software Development", "Topic :: Software Development :: Libraries" ], "description": "# python-annict\n\n[Annict API](https://docs.annict.com/ja/api/) wrapper for Python\n\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/e7936cf6e72a4e14b3bfb07879de1c3d)](https://app.codacy.com/app/hiro.ashiya/python-annict?utm_source=github.com&utm_medium=referral&utm_content=kk6/python-annict&utm_campaign=Badge_Grade_Dashboard)\n[![CircleCI](https://img.shields.io/circleci/project/github/kk6/python-annict.svg?style=flat-square)](https://circleci.com/gh/kk6/python-annict)\n[![PyPI](https://img.shields.io/pypi/v/annict.svg?style=flat-square)](https://pypi.org/project/annict/)\n[![License](https://img.shields.io/pypi/l/annict.svg)](https://pypi.org/project/annict/)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)\n\n**python-annict** officially supports Python 3.6 or higher.\n\n## Installation\n\n```bash\npip install annict\n```\n\n## Quickstart\n\n### Authentication\n\nAcquire the URL for authentication code.\n\n```python\n>>> from annict.auth import OAuthHandler\n>>> handler = OAuthHandler(client_id='Your client ID', client_secret='Your client secret')\n>>> url = handler.get_authorization_url(scope='read write')\n>>> print(url)\n```\n\nOpen the browser and access the URL you obtained, the authentication code will be displayed.\nIt will be passed to the `handler.authenticate()` 's argument to get the access token.\n\n```python\n>>> handler.authenticate(code='Authentication code')\n>>> print(handler.get_access_token())\n```\n\nNote that this authentication flow is unnecessary when issuing a personal access token on Annict and using it.\n\nSee: [Annict API: \u500b\u4eba\u7528\u30a2\u30af\u30bb\u30b9\u30c8\u30fc\u30af\u30f3\u304c\u767a\u884c\u3067\u304d\u308b\u3088\u3046\u306b\u306a\u308a\u307e\u3057\u305f](http://blog.annict.com/post/157138114218/personal-access-token)\n\n### Hello world\n\n\n```python\n>>> from annict.api import API\n>>> annict = API('Your access token')\n>>> results = annict.works(filter_title=\"Re:\u30bc\u30ed\u304b\u3089\u59cb\u3081\u308b\u7570\u4e16\u754c\u751f\u6d3b\")\n>>> print(results[0].title)\nRe:\u30bc\u30ed\u304b\u3089\u59cb\u3081\u308b\u7570\u4e16\u754c\u751f\u6d3b\n```\n\n### Cache\n\nFor now, we do not have our own cache system. However, caching is also important to reduce the load on AnnictAPI.\n\nSo I introduce a cache plugin for *requests* library called [requests_cache](https://github.com/reclosedev/requests-cache).\n\nInstall with pip.\n\n```bash\npip insall requests_cache\n```\n\n*requests_cache* is very easy to use.\n\n```python\n>>> import requests_cache\n>>> requests_cache.install_cache(cache_name='annict', backend='memory', expire_after=300)\n>>> # At first, from Annict API.\n>>> api.me()\n>>> # You can get results from cache, if it is within the expiration time.\n>>> api.me()\n\n```\n\nFor more information: [Requests-cache documentation](https://requests-cache.readthedocs.io/en/latest/) \n\n## Documentation\n\n- [This library's documentation](https://pythonhosted.org/annict/)\n- [Annict Docs(Japanese)](https://docs.annict.com/ja/)\n", "description_content_type": "text/markdown", "docs_url": "https://pythonhosted.org/annict/", "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://annict.jp/userland/projects/7", "keywords": "", "license": "MIT", "maintainer": "kk6", "maintainer_email": "hiro.ashiya@gmail.com", "name": "annict", "package_url": "https://pypi.org/project/annict/", "platform": "", "project_url": "https://pypi.org/project/annict/", "project_urls": { "Documentation": "https://pythonhosted.org/annict/", "Homepage": "https://annict.jp/userland/projects/7", "Repository": "https://github.com/kk6/python-annict" }, "release_url": "https://pypi.org/project/annict/0.7.0/", "requires_dist": [ "rauth (>=0.7.3,<0.8.0)", "requests (>=2.21,<3.0)", "requests-cache (>=0.4.13,<0.5.0)", "furl (>=2.0,<3.0)", "arrow (>=0.12.1,<0.13.0)" ], "requires_python": ">=3.6,<4.0", "summary": "Annict API for python", "version": "0.7.0" }, "last_serial": 4633578, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "f9020594e12f5080d7cfe346439cc566", "sha256": "bac84e6fc6229eed88fb8143b1a342ef78980adf1b670037d8b0fc5937e6f434" }, "downloads": -1, "filename": "annict-0.0.1-py3.5.egg", "has_sig": false, "md5_digest": "f9020594e12f5080d7cfe346439cc566", "packagetype": "bdist_egg", "python_version": "3.5", "requires_python": null, "size": 15481, "upload_time": "2017-04-10T12:43:46", "url": "https://files.pythonhosted.org/packages/98/f9/be403151d05bc9467680bb00bb8171c362991004e6f33bdfca5760c3af0c/annict-0.0.1-py3.5.egg" } ], "0.4.0": [ { "comment_text": "", "digests": { "md5": "769d6495c1b11d7401d6dc505db0cd45", "sha256": "8f4c75681dbc16faba29582a574f4e815930817cbbdb92d564d70be437bd79fd" }, "downloads": -1, "filename": "annict-0.4.0-py3.6.egg", "has_sig": false, "md5_digest": "769d6495c1b11d7401d6dc505db0cd45", "packagetype": "bdist_egg", "python_version": "3.6", "requires_python": null, "size": 16988, "upload_time": "2017-04-10T12:43:48", "url": "https://files.pythonhosted.org/packages/9c/fe/45d1dfdf3ed0187f50ab799fd977026591e6f712f800d0f015c7ecb54ff9/annict-0.4.0-py3.6.egg" } ], "0.5.0": [ { "comment_text": "", "digests": { "md5": "a2fdb4fe68ef5834203e19a466851511", "sha256": "d2d56f5efa6203a93f8ae32722c9a9be31e7e420d54bbe590cfd8c25bf41a280" }, "downloads": -1, "filename": "annict-0.5.0-py3.6.egg", "has_sig": false, "md5_digest": "a2fdb4fe68ef5834203e19a466851511", "packagetype": "bdist_egg", "python_version": "3.6", "requires_python": null, "size": 19234, "upload_time": "2017-04-10T12:44:27", "url": "https://files.pythonhosted.org/packages/6e/ff/6edd71f6b0d6c0d43815efface896e94b9860865e7fa2584608f9f6bf62f/annict-0.5.0-py3.6.egg" }, { "comment_text": "", "digests": { "md5": "1bdb300f8dffabfd11279938d1a74093", "sha256": "1ea41bd16223e2b7daa6bb9c5f43d2f1c29638d0b02ef21bec0b08b2c8d74929" }, "downloads": -1, "filename": "annict-0.5.0-py3-none-any.whl", "has_sig": false, "md5_digest": "1bdb300f8dffabfd11279938d1a74093", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 11250, "upload_time": "2017-04-10T12:43:41", "url": "https://files.pythonhosted.org/packages/16/a6/0c3ace5a485e0f9b9d00e6cb4a980ae1a37ff44471e0d58531e77f65f82a/annict-0.5.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0ebc5ca6c978b1c559cf1e5a8de7008b", "sha256": "2c4ad869ef04110146fbdef14d90703e8b86eb6824b0fb7de44cb727249c2f95" }, "downloads": -1, "filename": "annict-0.5.0.tar.gz", "has_sig": false, "md5_digest": "0ebc5ca6c978b1c559cf1e5a8de7008b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 29137, "upload_time": "2017-04-10T12:44:37", "url": "https://files.pythonhosted.org/packages/a6/b0/91fdf610ed5c68babc7a7d22570aa295e2178067fd3dd46ed5872b5274d5/annict-0.5.0.tar.gz" } ], "0.5.1": [ { "comment_text": "", "digests": { "md5": "b65dc1f7ea4d9fb7543211bb5acec2ed", "sha256": "2f2b2cd62e2227f637bee38ce7bd913ca65c85e04f580eac9ce804cf36e0d8cb" }, "downloads": -1, "filename": "annict-0.5.1-py3-none-any.whl", "has_sig": false, "md5_digest": "b65dc1f7ea4d9fb7543211bb5acec2ed", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 11236, "upload_time": "2017-04-10T12:43:43", "url": "https://files.pythonhosted.org/packages/77/37/13ffd6ce63bbf68cb873d9acf7ab8fc72b5b96df93d611eadc9d8b6d1dbd/annict-0.5.1-py3-none-any.whl" } ], "0.5.2": [ { "comment_text": "", "digests": { "md5": "e7b4c503df982909be6d760090a7ea07", "sha256": "84d08495419474b90bcf1e7bf60395fab42c4b58923bd5daf4753ad918882a45" }, "downloads": -1, "filename": "annict-0.5.2-py3-none-any.whl", "has_sig": false, "md5_digest": "e7b4c503df982909be6d760090a7ea07", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 11252, "upload_time": "2017-04-10T12:43:44", "url": "https://files.pythonhosted.org/packages/a5/21/96fd580262640efd3948abc7776e7731adce6604a949a451dc65bf7accef/annict-0.5.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0823a916712eb022946795378022fc6a", "sha256": "bae55f8f5cd572a3291b62fd0f2c466a06483a4c9fe1764417a5f6d1661a5f41" }, "downloads": -1, "filename": "annict-0.5.2.tar.gz", "has_sig": false, "md5_digest": "0823a916712eb022946795378022fc6a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 29139, "upload_time": "2017-04-10T15:24:58", "url": "https://files.pythonhosted.org/packages/a3/1f/25539f86e5358f34934ded29f79c0060831177235b96e9abc8fa5d61bb79/annict-0.5.2.tar.gz" } ], "0.6.1": [ { "comment_text": "", "digests": { "md5": "06c18e2a3f128dca0780f0b4107fa256", "sha256": "73cfc8e687de8e916fd481002315d40b79e3a8712eaecb7869a4dda8862d26b6" }, "downloads": -1, "filename": "annict-0.6.1-py3-none-any.whl", "has_sig": false, "md5_digest": "06c18e2a3f128dca0780f0b4107fa256", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 13970, "upload_time": "2017-04-15T14:21:56", "url": "https://files.pythonhosted.org/packages/6b/5e/341fb3e2f54bf4edc985f7f7b41d2320c768d10d552dc19d8c1b2758363f/annict-0.6.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3c5efa69a72061983d93b7f3cc9f58ac", "sha256": "201b908157e69609a9f115a0820b5fa98777aec1247015c8521da255f8a31850" }, "downloads": -1, "filename": "annict-0.6.1.tar.gz", "has_sig": false, "md5_digest": "3c5efa69a72061983d93b7f3cc9f58ac", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 37654, "upload_time": "2017-04-15T14:21:59", "url": "https://files.pythonhosted.org/packages/ad/c3/1616d08e315f1711b9c2c923bcdb88ac74aacea9210012c5e6e5234c09a7/annict-0.6.1.tar.gz" } ], "0.7.0": [ { "comment_text": "", "digests": { "md5": "365c4158744144e83d4048e0c8479387", "sha256": "74978c0be438a8a508416a808a9904c8a5e1f0f050b10ed7c3e3a8fd97fabc36" }, "downloads": -1, "filename": "annict-0.7.0-py3-none-any.whl", "has_sig": false, "md5_digest": "365c4158744144e83d4048e0c8479387", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6,<4.0", "size": 45898, "upload_time": "2018-12-25T14:34:33", "url": "https://files.pythonhosted.org/packages/e7/58/720933a34828f46f19ecef3ed4b3d5e33df80f27781ba885aad1fbee2037/annict-0.7.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a738ad0e45f5ec45f047cdbd1ad4470e", "sha256": "29001f7aba31a6ec0bc0c1c1868f4490b78e058a3e93c3e0f54222e70b52bff2" }, "downloads": -1, "filename": "annict-0.7.0.tar.gz", "has_sig": false, "md5_digest": "a738ad0e45f5ec45f047cdbd1ad4470e", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6,<4.0", "size": 11118, "upload_time": "2018-12-25T14:34:35", "url": "https://files.pythonhosted.org/packages/3a/47/b67c65341da26f9113696f59db04c780b9c7a263ee2d4bf605cb25b2951d/annict-0.7.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "365c4158744144e83d4048e0c8479387", "sha256": "74978c0be438a8a508416a808a9904c8a5e1f0f050b10ed7c3e3a8fd97fabc36" }, "downloads": -1, "filename": "annict-0.7.0-py3-none-any.whl", "has_sig": false, "md5_digest": "365c4158744144e83d4048e0c8479387", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6,<4.0", "size": 45898, "upload_time": "2018-12-25T14:34:33", "url": "https://files.pythonhosted.org/packages/e7/58/720933a34828f46f19ecef3ed4b3d5e33df80f27781ba885aad1fbee2037/annict-0.7.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a738ad0e45f5ec45f047cdbd1ad4470e", "sha256": "29001f7aba31a6ec0bc0c1c1868f4490b78e058a3e93c3e0f54222e70b52bff2" }, "downloads": -1, "filename": "annict-0.7.0.tar.gz", "has_sig": false, "md5_digest": "a738ad0e45f5ec45f047cdbd1ad4470e", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6,<4.0", "size": 11118, "upload_time": "2018-12-25T14:34:35", "url": "https://files.pythonhosted.org/packages/3a/47/b67c65341da26f9113696f59db04c780b9c7a263ee2d4bf605cb25b2951d/annict-0.7.0.tar.gz" } ] }