{
    "info": {
        "author": "py-ipfs-api team",
        "author_email": "",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 3 - Alpha",
            "Intended Audience :: Developers",
            "Intended Audience :: Information Technology",
            "Intended Audience :: Science/Research",
            "License :: OSI Approved :: MIT License",
            "Programming Language :: Python :: 2",
            "Programming Language :: Python :: 2.7",
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.4",
            "Programming Language :: Python :: 3.5",
            "Programming Language :: Python :: 3.6",
            "Topic :: Internet",
            "Topic :: Scientific/Engineering",
            "Topic :: System :: Filesystems",
            "Topic :: System :: Networking"
        ],
        "description": "# py-ipfs-api\n\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.io/)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](https://webchat.freenode.net/?channels=%23ipfs)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![](https://img.shields.io/pypi/v/ipfsapi.svg?style=flat-square)](https://pypi.python.org/pypi/ipfsapi)\n\n![Python IPFS HTTP Client Library](https://ipfs.io/ipfs/QmQJ68PFMDdAsgCZvA1UVzzn18asVcf7HVvCDgpjiSCAse)\n\n## Deprecation Notice\n\n**Important:** The `ipfsapi` PIP package and Python module have both been renamed to `ipfshttpclient` and this library has been converted into a thin wrapper around that other library. Only critical bug-fixes will be accepted for this package. Please see [migration notes on the new package](https://github.com/ipfs/py-ipfs-http-client/blob/master/README.md#important-changes-from-ipfsapi-04x) for details on how to proceed.\n\n*The remainder of this README remains as a historical curiousity and will not be updated anymore.*\n\n## Table of Contents\n\n- [Install](#install)\n- [Usage](#usage)\n- [Documentation](#documentation)\n  - [Important changes from ipfsApi 0.2.x](#important-changes-from-ipfsapi-02x)\n- [Featured Projects](#featured-projects)\n- [Contribute](#contribute)\n  - [IRC](#irc)\n  - [Bug reports](#bug-reports)\n  - [Pull requests](#pull-requests)\n- [License](#license)\n\n## Install\n\nInstall with pip:\n\n```sh\npip install ipfsapi\n```\n\n## Usage\n\nBasic use-case (requires a running instance of IPFS daemon):\n\n```py\n>>> import ipfsapi\n>>> api = ipfsapi.connect('127.0.0.1', 5001)\n>>> res = api.add('test.txt')\n>>> res\n{'Hash': 'QmWxS5aNTFEc9XbMX1ASvLET1zrqEaTssqt33rVZQCQb22', 'Name': 'test.txt'}\n>>> api.cat(res['Hash'])\n'fdsafkljdskafjaksdjf\\n'\n```\n\nAdministrative functions:\n\n```py\n>>> api.id()\n{'Addresses': ['/ip4/127.0.0.1/tcp/4001/ipfs/QmS2C4MjZsv2iP1UDMMLCYqJ4WeJw8n3vXx1VKxW1UbqHS',\n               '/ip6/::1/tcp/4001/ipfs/QmS2C4MjZsv2iP1UDMMLCYqJ4WeJw8n3vXx1VKxW1UbqHS'],\n 'AgentVersion': 'go-ipfs/0.4.10',\n 'ID': 'QmS2C4MjZsv2iP1UDMMLCYqJ4WeJw8n3vXx1VKxW1UbqHS',\n 'ProtocolVersion': 'ipfs/0.1.0',\n 'PublicKey': 'CAASpgIwgg ... 3FcjAgMBAAE='}\n```\n\nPass in API options:\n\n```py\n>>> api.pin_ls(type='all')\n{'Keys': {'QmNMELyizsfFdNZW3yKTi1SE2pErifwDTXx6vvQBfwcJbU': {'Count': 1,\n                                                             'Type': 'indirect'},\n          'QmNQ1h6o1xJARvYzwmySPsuv9L5XfzS4WTvJSTAWwYRSd8': {'Count': 1,\n                                                             'Type': 'indirect'},\n          \u2026\n```\n\nAdd a directory and match against a filename pattern:\n\n```py\n>>> api.add('photos', match='*.jpg')\n[{'Hash': 'QmcqBstfu5AWpXUqbucwimmWdJbu89qqYmE3WXVktvaXhX',\n  'Name': 'photos/photo1.jpg'},\n {'Hash': 'QmSbmgg7kYwkSNzGLvWELnw1KthvTAMszN5TNg3XQ799Fu',\n  'Name': 'photos/photo2.jpg'},\n {'Hash': 'Qma6K85PJ8dN3qWjxgsDNaMjWjTNy8ygUWXH2kfoq9bVxH',\n  'Name': 'photos/photo3.jpg'}]\n```\n\nOr add a directory recursively:\n\n```py\n>>> api.add('fake_dir', recursive=True)\n[{'Hash': 'QmQcCtMgLVwvMQGu6mvsRYLjwqrZJcYtH4mboM9urWW9vX',\n  'Name': 'fake_dir/fsdfgh'},\n {'Hash': 'QmNuvmuFeeWWpxjCQwLkHshr8iqhGLWXFzSGzafBeawTTZ',\n  'Name': 'fake_dir/test2/llllg'},\n {'Hash': 'QmX1dd5DtkgoiYRKaPQPTCtXArUu4jEZ62rJBUcd5WhxAZ',\n  'Name': 'fake_dir/test2'},\n {'Hash': 'Qmenzb5J4fR9c69BbpbBhPTSp2Snjthu2hKPWGPPJUHb9M',\n  'Name': 'fake_dir'}]\n```\n\nThis module also contains some helper functions for adding strings and JSON to IPFS:\n\n```py\n>>> lst = [1, 77, 'lol']\n>>> client.add_json(lst)\n'QmQ4R5cCUYBWiJpNL7mFe4LDrwD6qBr5Re17BoRAY9VNpd'\n>>> client.get_json(_)\n[1, 77, 'lol']\n```\n\n## Documentation\n\nDocumentation (currently mostly API documentation unfortunately) is available on IPFS:\n\nhttps://ipfs.io/ipns/QmZ86ow1byeyhNRJEatWxGPJKcnQKG7s51MtbHdxxUddTH/Software/Python/ipfsapi/\n\nThe `ipfs` [command-line Client documentation](https://ipfs.io/docs/commands/) may also be useful in some cases.\n\n### Important changes from `ipfsApi 0.2.x`\n\n * The Python package has been renamed from `ipfsApi` to `ipfsapi`\n * The PIP module has been renamed from `ipfs-api` to `ipfsapi` (please update your requirement files)\n * A lot of changes in the internal code\n    - Commands have been completely removed\n    - Usage of `requests` or other libraries is considered an implementation detail from now on\n * Most parts of the library (except for `Client()`) are now considered internal and may therefore break at any time\n   ([reference](https://ipfs.io/ipns/QmZ86ow1byeyhNRJEatWxGPJKcnQKG7s51MtbHdxxUddTH/Software/Python/ipfsapi/internal_ref.html))\n    - We will try to keep breakage for these modules at a minimum\n    - If you require stabilisation of some feature please open an issue with the feature in question and your preceived use-case\n * Raised exceptions have been completely changed and are now documented with guaranteed backwards compatibility\n   ([reference](https://ipfs.io/ipns/QmZ86ow1byeyhNRJEatWxGPJKcnQKG7s51MtbHdxxUddTH/Software/Python/ipfsapi/api_ref.html#module-ipfsapi.exceptions))\n * The new `ipfsapi.connect()` function allows creating a `Client` instance, while also checking whether a compatible IPFS daemon instance is actually available\n * Methods in `Client()` now have parameters for options\n\n## Featured Projects\n\nProjects that currently use py-ipfs-api. If your project isn't here, feel free to submit a PR to add it!\n\n- [git-remote-ipfs](https://github.com/larsks/git-remote-ipfs) allows users to push and pull git repositories from the IPFS network.\n- [InterPlanetary Wayback](https://github.com/oduwsdl/ipwb) interfaces web archive ([WARC](https://www.iso.org/standard/44717.html)) files for distributed indexing and replay using IPFS.\n\n## Contribute\n\n### IRC\n\nJoin us on IRC at `#ipfs` on [chat.freenode.net](https://webchat.freenode.net) if you have any suggestions or questions,\nor if you just want to discuss IPFS and python.\n\n### Bug reports\n\nYou can submit bug reports using the [GitHub issue tracker](https://github.com/ipfs/python-ipfs-api/issues).\n\n### Pull requests\n\nPull requests are welcome.  Before submitting a new pull request, please\nmake sure that your code passes both the [code formatting](https://www.python.org/dev/peps/pep-0008/) check:\n\n    $ tox -e codestyle\n\nAnd the unit tests:\n\n    $ tox\n\nYou can arrange to run the code style tests automatically before each commit by\ninstalling a `pre-commit` hook:\n\n    $ ./tools/pre-commit --install\n\nPlease make sure to include new unit tests for new features or changes in\nbehavior.\n\n## License\n\nThis code is distributed under the terms of the [MIT license](https://opensource.org/licenses/MIT).  Details can be found in the file\n[LICENSE](LICENSE) in this repository.\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/ipfs/py-ipfs-http-client/tree/py-ipfs-api",
        "keywords": "ipfs storage distribution development",
        "license": "MIT License",
        "maintainer": "",
        "maintainer_email": "",
        "name": "ipfsapi",
        "package_url": "https://pypi.org/project/ipfsapi/",
        "platform": "",
        "project_url": "https://pypi.org/project/ipfsapi/",
        "project_urls": {
            "Documentation": "https://ipfs.io/ipns/12D3KooWEqnTdgqHnkkwarSrJjeMP2ZJiADWLYADaNvUb6SQNyPF/docs/",
            "Homepage": "https://github.com/ipfs/py-ipfs-http-client/tree/py-ipfs-api"
        },
        "release_url": "https://pypi.org/project/ipfsapi/0.4.4/",
        "requires_dist": [
            "ipfshttpclient>=0.4.10,<0.5.0",
            "netaddr",
            "six"
        ],
        "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*",
        "summary": "Python IPFS API client library",
        "version": "0.4.4"
    },
    "last_serial": 5263581,
    "releases": {
        "0.4.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "a7ee375cbae357953a60c7fa9b7fad48",
                    "sha256": "21127684b06f9e6d2be5edc5ae3605fc8512090e3d23b6aa12520a3e3e936f54"
                },
                "downloads": -1,
                "filename": "ipfsapi-0.4.0-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "a7ee375cbae357953a60c7fa9b7fad48",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 36413,
                "upload_time": "2016-09-13T19:57:57",
                "url": "https://files.pythonhosted.org/packages/63/29/c741462c5a08999ad8dab38da45c986d7dbd8218b29879b86b9e19228633/ipfsapi-0.4.0-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "f266a11ec889898d65af8c5242a448cf",
                    "sha256": "83b1c6a8fe45e13e58ecfddc55100b8f777714b349b28f2256bf5bab60d41857"
                },
                "downloads": -1,
                "filename": "ipfsapi-0.4.0.tar.gz",
                "has_sig": false,
                "md5_digest": "f266a11ec889898d65af8c5242a448cf",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 31796,
                "upload_time": "2016-09-13T19:58:00",
                "url": "https://files.pythonhosted.org/packages/88/a0/de1c466478c9535ade8ca5b48f9de59287f244bdfe8dd741c856ce5c1f70/ipfsapi-0.4.0.tar.gz"
            }
        ],
        "0.4.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "e91512a320afebc40f0eca421ac25a38",
                    "sha256": "09fb3e404a20a8b68b83b787077ad08702fb2e7afc6cd3e1cf596a98f34710bf"
                },
                "downloads": -1,
                "filename": "ipfsapi-0.4.1-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "e91512a320afebc40f0eca421ac25a38",
                "packagetype": "bdist_wheel",
                "python_version": "3.5",
                "requires_python": null,
                "size": 41687,
                "upload_time": "2017-06-02T15:08:36",
                "url": "https://files.pythonhosted.org/packages/a8/59/f375ed406062f4de1cf38e0519573849c8a0dc2510990ad75e29b467bddd/ipfsapi-0.4.1-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "fbafde085af02fbc76ee8e5471a16377",
                    "sha256": "5221a5b8e6b1d8502b59d137e0e9ffb18051a460775ac1d34b9575056c344f61"
                },
                "downloads": -1,
                "filename": "ipfsapi-0.4.1.tar.gz",
                "has_sig": false,
                "md5_digest": "fbafde085af02fbc76ee8e5471a16377",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 37137,
                "upload_time": "2017-06-02T14:35:33",
                "url": "https://files.pythonhosted.org/packages/72/c3/009c59bb4222682354638b9f1fbb541479dcd7060a07064817aeca462db5/ipfsapi-0.4.1.tar.gz"
            }
        ],
        "0.4.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "4d084a11c25867e7de705a683f254ac3",
                    "sha256": "d3ca77b539ed60d3ae0bedfadf6cfb54a51ac9642ea82068f84370c1a2b07ad8"
                },
                "downloads": -1,
                "filename": "ipfsapi-0.4.2-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "4d084a11c25867e7de705a683f254ac3",
                "packagetype": "bdist_wheel",
                "python_version": "3.6",
                "requires_python": null,
                "size": 41189,
                "upload_time": "2017-08-09T19:36:35",
                "url": "https://files.pythonhosted.org/packages/fa/be/b35dfd8f56793dcd8977135898e5940c86801b528686964f19b6b619135c/ipfsapi-0.4.2-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "af8c1837e9b64c7fceba30287c1a1097",
                    "sha256": "cfcfa5d07efb413e6583104c70b338eda7e947c0d18d4ec0f627119db9589dba"
                },
                "downloads": -1,
                "filename": "ipfsapi-0.4.2.tar.gz",
                "has_sig": false,
                "md5_digest": "af8c1837e9b64c7fceba30287c1a1097",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 38535,
                "upload_time": "2017-08-09T19:36:32",
                "url": "https://files.pythonhosted.org/packages/dd/2c/3685cbcec33c8300b4928d3fe9025d8878602dc35e36686a508b41f4ff75/ipfsapi-0.4.2.tar.gz"
            }
        ],
        "0.4.2.post1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "007d384658c8628b3a9f50b755915e4f",
                    "sha256": "9c0483057542e13ba19b27d19e7b9313899c72eb7cd4dac6a2b4564190b6d417"
                },
                "downloads": -1,
                "filename": "ipfsapi-0.4.2.post1-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "007d384658c8628b3a9f50b755915e4f",
                "packagetype": "bdist_wheel",
                "python_version": "3.6",
                "requires_python": null,
                "size": 41276,
                "upload_time": "2017-08-09T19:57:20",
                "url": "https://files.pythonhosted.org/packages/04/59/bf06b69efc1c0d9137cdc71b45f36b909a44e336d6ffe2bb876a11c914f6/ipfsapi-0.4.2.post1-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "12d5376da52bff9423b9c08f879e5762",
                    "sha256": "e5748871dfa8afd4acdc7b12dd64c1a26276d702844fe16605dcf00d35bb3c60"
                },
                "downloads": -1,
                "filename": "ipfsapi-0.4.2.post1.tar.gz",
                "has_sig": false,
                "md5_digest": "12d5376da52bff9423b9c08f879e5762",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 38544,
                "upload_time": "2017-08-09T19:57:03",
                "url": "https://files.pythonhosted.org/packages/ff/3a/b902bca014e190ea5029061f838eceb2636b2970ea45128fb93ca54cb874/ipfsapi-0.4.2.post1.tar.gz"
            }
        ],
        "0.4.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "23b980fa9187ea513538c13b7c28f6fa",
                    "sha256": "45820cc8605894e78ad42b558f4627dc9dabb22dc86830f451a4648d28d669d5"
                },
                "downloads": -1,
                "filename": "ipfsapi-0.4.3-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "23b980fa9187ea513538c13b7c28f6fa",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*",
                "size": 142839,
                "upload_time": "2018-06-06T13:08:57",
                "url": "https://files.pythonhosted.org/packages/b1/c0/73dbe50a76077a175e41c51ea529e21d54b924600809c99aac74a5fb00c7/ipfsapi-0.4.3-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "1b56ffee373e23db6936338e5fec5f17",
                    "sha256": "f2e7cc0c3f1f3b96730638072ab41ca76e1860a8b91fc5f815f66af886019f8e"
                },
                "downloads": -1,
                "filename": "ipfsapi-0.4.3.tar.gz",
                "has_sig": false,
                "md5_digest": "1b56ffee373e23db6936338e5fec5f17",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*",
                "size": 62390,
                "upload_time": "2018-06-06T13:08:59",
                "url": "https://files.pythonhosted.org/packages/5e/15/a837c7bf54bed3175f5f4b8139619fac78ae5eb7256b77a3b705e4bf94d6/ipfsapi-0.4.3.tar.gz"
            }
        ],
        "0.4.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "4741163e77b0f2e286629190a1f0ac7d",
                    "sha256": "4d3fbd8b130b9d7372d94cda7aadb67b9346f261fc99fb811493e8a0a4c60550"
                },
                "downloads": -1,
                "filename": "ipfsapi-0.4.4-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "4741163e77b0f2e286629190a1f0ac7d",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*",
                "size": 32338,
                "upload_time": "2019-05-13T17:33:16",
                "url": "https://files.pythonhosted.org/packages/68/58/3e7409fe4d481b389ac2f8ad8e1424b541e6a4bf983c449ca0932d5d87cc/ipfsapi-0.4.4-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "26e79c424dd741cb6f52b5e0bb835d64",
                    "sha256": "8fde5f2cab045e326dd2735220c28c8ec995ae441cf475d46178efde4869ad9d"
                },
                "downloads": -1,
                "filename": "ipfsapi-0.4.4.tar.gz",
                "has_sig": false,
                "md5_digest": "26e79c424dd741cb6f52b5e0bb835d64",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*",
                "size": 33520,
                "upload_time": "2019-05-13T17:33:26",
                "url": "https://files.pythonhosted.org/packages/3a/df/6dc3270c03d50b42c0995fe00a1bbfc162ab13935ebe1e18c197c74ddd8c/ipfsapi-0.4.4.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "4741163e77b0f2e286629190a1f0ac7d",
                "sha256": "4d3fbd8b130b9d7372d94cda7aadb67b9346f261fc99fb811493e8a0a4c60550"
            },
            "downloads": -1,
            "filename": "ipfsapi-0.4.4-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4741163e77b0f2e286629190a1f0ac7d",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*",
            "size": 32338,
            "upload_time": "2019-05-13T17:33:16",
            "url": "https://files.pythonhosted.org/packages/68/58/3e7409fe4d481b389ac2f8ad8e1424b541e6a4bf983c449ca0932d5d87cc/ipfsapi-0.4.4-py2.py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "26e79c424dd741cb6f52b5e0bb835d64",
                "sha256": "8fde5f2cab045e326dd2735220c28c8ec995ae441cf475d46178efde4869ad9d"
            },
            "downloads": -1,
            "filename": "ipfsapi-0.4.4.tar.gz",
            "has_sig": false,
            "md5_digest": "26e79c424dd741cb6f52b5e0bb835d64",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*",
            "size": 33520,
            "upload_time": "2019-05-13T17:33:26",
            "url": "https://files.pythonhosted.org/packages/3a/df/6dc3270c03d50b42c0995fe00a1bbfc162ab13935ebe1e18c197c74ddd8c/ipfsapi-0.4.4.tar.gz"
        }
    ]
}