Metadata-Version: 1.1
Name: ipfsapi
Version: 0.4.2.post1
Summary: IPFS API Bindings for Python
Home-page: https://github.com/ipfs/py-ipfs-api
Author: py-ipfs-api team
Author-email: UNKNOWN
License: MIT
Description: py-ipfs-api
        ===========
        
        |image0| |image1| |image2| |standard-readme compliant| |image4| |Build
        Status|
        
        .. figure:: https://ipfs.io/ipfs/QmQJ68PFMDdAsgCZvA1UVzzn18asVcf7HVvCDgpjiSCAse
           :alt: A python client library for the IPFS API
        
           A python client library for the IPFS API
        
        Check out `the client API
        reference <https://ipfs.io/ipns/QmZ86ow1byeyhNRJEatWxGPJKcnQKG7s51MtbHdxxUddTH/Software/Python/ipfsapi/>`__
        for the full command reference.
        
        | **Important:** The ``py-ipfs-api`` PIP package and Python module have
          both been renamed to ``ipfsapi`` (no dash, lower-case ``a``).
        | The legacy ``ipfs-api``/``ipfsApi`` package/module will only work for
          IPFS 0.3.x and Python 2 and is deprecated. `Please
          upgrade <#important-changes-from-ipfsapi-02x>`__!
        
        **Note:** This library constantly has to change to stay compatible with
        the IPFS HTTP API. Currently, this library is tested against `go-ipfs
        v0.4.10 <https://github.com/ipfs/go-ipfs/releases/tag/v0.4.10>`__. You
        may experience compatibility issues when attempting to use it with other
        versions of go-ipfs.
        
        Table of Contents
        -----------------
        
        -  `Install <#install>`__
        -  `Usage <#usage>`__
        -  `Documentation <#documentation>`__
        -  `Important changes from ipfsApi
           0.2.x <#important-changes-from-ipfsapi-02x>`__
        -  `Featured Projects <#featured-projects>`__
        -  `Contribute <#contribute>`__
        -  `IRC <#irc>`__
        -  `Bug reports <#bug-reports>`__
        -  `Pull requests <#pull-requests>`__
        -  `License <#license>`__
        
        Install
        -------
        
        Install with pip:
        
        .. code:: sh
        
            pip install ipfsapi
        
        Usage
        -----
        
        Basic use-case (requires a running instance of IPFS daemon):
        
        .. code:: py
        
            >>> import ipfsapi
            >>> api = ipfsapi.connect('127.0.0.1', 5001)
            >>> res = api.add('test.txt')
            >>> res
            {'Hash': 'QmWxS5aNTFEc9XbMX1ASvLET1zrqEaTssqt33rVZQCQb22', 'Name': 'test.txt'}
            >>> api.cat(res['Hash'])
            'fdsafkljdskafjaksdjf\n'
        
        Administrative functions:
        
        .. code:: py
        
            >>> api.id()
            {'Addresses': ['/ip4/127.0.0.1/tcp/4001/ipfs/QmS2C4MjZsv2iP1UDMMLCYqJ4WeJw8n3vXx1VKxW1UbqHS',
                           '/ip6/::1/tcp/4001/ipfs/QmS2C4MjZsv2iP1UDMMLCYqJ4WeJw8n3vXx1VKxW1UbqHS'],
             'AgentVersion': 'go-ipfs/0.4.10',
             'ID': 'QmS2C4MjZsv2iP1UDMMLCYqJ4WeJw8n3vXx1VKxW1UbqHS',
             'ProtocolVersion': 'ipfs/0.1.0',
             'PublicKey': 'CAASpgIwgg ... 3FcjAgMBAAE='}
        
        Pass in API options:
        
        .. code:: py
        
            >>> api.pin_ls(type='all')
            {'Keys': {'QmNMELyizsfFdNZW3yKTi1SE2pErifwDTXx6vvQBfwcJbU': {'Count': 1,
                                                                         'Type': 'indirect'},
                      'QmNQ1h6o1xJARvYzwmySPsuv9L5XfzS4WTvJSTAWwYRSd8': {'Count': 1,
                                                                         'Type': 'indirect'},
                      …
        
        Add a directory and match against a filename pattern:
        
        .. code:: py
        
            >>> api.add('photos', match='*.jpg')
            [{'Hash': 'QmcqBstfu5AWpXUqbucwimmWdJbu89qqYmE3WXVktvaXhX',
              'Name': 'photos/photo1.jpg'},
             {'Hash': 'QmSbmgg7kYwkSNzGLvWELnw1KthvTAMszN5TNg3XQ799Fu',
              'Name': 'photos/photo2.jpg'},
             {'Hash': 'Qma6K85PJ8dN3qWjxgsDNaMjWjTNy8ygUWXH2kfoq9bVxH',
              'Name': 'photos/photo3.jpg'}]
        
        Or add a directory recursively:
        
        .. code:: py
        
            >>> api.add('fake_dir', recursive=True)
            [{'Hash': 'QmQcCtMgLVwvMQGu6mvsRYLjwqrZJcYtH4mboM9urWW9vX',
              'Name': 'fake_dir/fsdfgh'},
             {'Hash': 'QmNuvmuFeeWWpxjCQwLkHshr8iqhGLWXFzSGzafBeawTTZ',
              'Name': 'fake_dir/test2/llllg'},
             {'Hash': 'QmX1dd5DtkgoiYRKaPQPTCtXArUu4jEZ62rJBUcd5WhxAZ',
              'Name': 'fake_dir/test2'},
             {'Hash': 'Qmenzb5J4fR9c69BbpbBhPTSp2Snjthu2hKPWGPPJUHb9M',
              'Name': 'fake_dir'}]
        
        This module also contains some helper functions for adding strings and
        JSON to IPFS:
        
        .. code:: py
        
            >>> lst = [1, 77, 'lol']
            >>> client.add_json(lst)
            'QmQ4R5cCUYBWiJpNL7mFe4LDrwD6qBr5Re17BoRAY9VNpd'
            >>> client.get_json(_)
            [1, 77, 'lol']
        
        Documentation
        -------------
        
        Documentation (currently mostly API documentation unfortunately) is
        available on IPFS:
        
        https://ipfs.io/ipns/QmZ86ow1byeyhNRJEatWxGPJKcnQKG7s51MtbHdxxUddTH/Software/Python/ipfsapi/
        
        The ``ipfs`` `command-line Client
        documentation <https://ipfs.io/docs/commands/>`__ may also be useful in
        some cases.
        
        Important changes from ``ipfsApi 0.2.x``
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        -  The Python package has been renamed from ``ipfsApi`` to ``ipfsapi``
        -  The PIP module has been renamed from ``ipfs-api`` to ``ipfsapi``
           (please update your requirement files)
        -  A lot of changes in the internal code
        
           -  Commands have been completely removed
           -  Usage of ``requests`` or other libraries is considered an
              implementation detail from now on
        
        -  Most parts of the library (except for ``Client()``) are now
           considered internal and may therefore break at any time
           (`reference <https://ipfs.io/ipns/QmZ86ow1byeyhNRJEatWxGPJKcnQKG7s51MtbHdxxUddTH/Software/Python/ipfsapi/internal_ref.html>`__)
        
           -  We will try to keep breakage for these modules at a minimum
           -  If you require stabilisation of some feature please open an issue
              with the feature in question and your preceived use-case
        
        -  Raised exceptions have been completely changed and are now documented
           with guaranteed backwards compatibility
           (`reference <https://ipfs.io/ipns/QmZ86ow1byeyhNRJEatWxGPJKcnQKG7s51MtbHdxxUddTH/Software/Python/ipfsapi/api_ref.html#module-ipfsapi.exceptions>`__)
        -  The new ``ipfsapi.connect()`` function allows creating a ``Client``
           instance, while also checking whether a compatible IPFS daemon
           instance is actually available
        -  Methods in ``Client()`` now have parameters for options
        
        Featured Projects
        -----------------
        
        Projects that currently use py-ipfs-api. If your project isn't here,
        feel free to submit a PR to add it!
        
        -  `git-remote-ipfs <https://github.com/larsks/git-remote-ipfs>`__
           allows users to push and pull git repositories from the IPFS network.
        -  `InterPlanetary Wayback <https://github.com/oduwsdl/ipwb>`__
           interfaces web archive
           (`WARC <http://www.iso.org/iso/catalogue_detail.htm?csnumber=44717>`__)
           files for distributed indexing and replay using IPFS.
        
        Contribute
        ----------
        
        IRC
        ~~~
        
        Join us on IRC at ``#ipfs`` on
        `chat.freenode.net <https://webchat.freenode.net>`__ if you have any
        suggestions or questions, or if you just want to discuss IPFS and
        python.
        
        Bug reports
        ~~~~~~~~~~~
        
        You can submit bug reports using the `GitHub issue
        tracker <https://github.com/ipfs/python-ipfs-api/issues>`__.
        
        Pull requests
        ~~~~~~~~~~~~~
        
        Pull requests are welcome. Before submitting a new pull request, please
        make sure that your code passes both the
        `pep8 <https://www.python.org/dev/peps/pep-0008/>`__ formatting check:
        
        ::
        
            $ tox -e pep8
        
        And the unit tests:
        
        ::
        
            $ tox
        
        You can arrange to run the pep8 tests automatically before each commit
        by installing a ``pre-commit`` hook:
        
        ::
        
            $ ./tools/pre-commit --install
        
        Please make sure to include new unit tests for new features or changes
        in behavior.
        
        License
        -------
        
        This code is distributed under the terms of the `MIT
        license <https://opensource.org/licenses/MIT>`__. Details can be found
        in the file `LICENSE <LICENSE>`__ in this repository.
        
        .. |image0| image:: https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square
           :target: http://ipn.io
        .. |image1| image:: https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square
           :target: http://ipfs.io/
        .. |image2| image:: https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square
           :target: http://webchat.freenode.net/?channels=%23ipfs
        .. |standard-readme compliant| image:: https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square
           :target: https://github.com/RichardLitt/standard-readme
        .. |image4| image:: https://img.shields.io/pypi/v/ipfsapi.svg?style=flat-square
           :target: https://pypi.python.org/pypi/ipfsapi
        .. |Build Status| image:: https://travis-ci.org/ipfs/py-ipfs-api.svg?branch=master
           :target: https://travis-ci.org/ipfs/py-ipfs-api
        
Keywords: ipfs storage distribution development
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Internet
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: System :: Filesystems
Classifier: Topic :: System :: Networking
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
