Metadata-Version: 1.1
Name: aioipfs
Version: 0.4.6
Summary: Asynchronous IPFS client library
Home-page: https://gitlab.com/cipres/aioipfs
Author: David Ferlier
Author-email: galacteek@protonmail.com
License: LGPLv3
Description: =======
        aioipfs
        =======
        
        :info: Asynchronous IPFS_ client library
        
        **aioipfs** is a python3 library providing an asynchronous API for IPFS_
        
        Installation
        ============
        
        .. code-block:: shell
        
            pip install aioipfs
        
        Usage examples
        ==============
        
        Get an IPFS resource
        --------------------
        
        .. code-block:: python
        
            import sys
            import asyncio
        
            import aioipfs
        
            async def get(ipfshash):
                client = aioipfs.AsyncIPFS()
                await client.get(ipfshash, dstdir='.')
                await client.close()
        
            loop = asyncio.get_event_loop()
            loop.run_until_complete(get(sys.argv[1]))
            loop.close()
        
        Add some files
        --------------
        
        This example will import all files and directories specified on the command
        line. Note that the **add** API function is an asynchronous generator and
        therefore needs to be used with the *async for* syntax.
        
        .. code-block:: python
        
            import sys
            import asyncio
        
            import aioipfs
        
            async def add_files(files):
                client = aioipfs.AsyncIPFS()
        
                async for added_file in client.add(*files, recursive=True):
                    print('Imported file {0}, CID: {1}'.format(
                        added_file['Name'], added_file['Hash']))
        
                await client.close()
        
            loop = asyncio.get_event_loop()
            loop.run_until_complete(add_files(sys.argv[1:]))
            loop.close()
        
        Pubsub service
        --------------
        
        .. code-block:: python
        
            async def pubsub_serve(topic):
                async with aioipfs.AsyncIPFS() as cli:
                    async for message in cli.pubsub.sub(topic):
                        print('Received message from', message['from'])
                        await cli.pubsub.pub(topic, message['data'])
        
        Features
        ========
        
        Async file writing on get operations
        ------------------------------------
        
        The **aiofiles** library is used to asynchronously write data retrieved from
        the IPFS daemon when using the */api/v0/get* API call, to avoid blocking the
        event loop. TAR extraction is done in asyncio's threadpool.
        
        Requirements
        ============
        
        - Python >= 3.6
        - aiohttp_
        - aiofiles_
        - yarl_
        
        .. _aiohttp: https://pypi.python.org/pypi/aiohttp
        .. _aiofiles: https://pypi.python.org/pypi/aiofiles
        .. _yarl: https://pypi.python.org/pypi/yarl
        .. _async-generator: https://pypi.python.org/pypi/async_generator
        .. _IPFS: https://ipfs.io
        
        License
        =======
        
        **aioipfs** is offered under the GNU Lesser GPL3 (LGPL3) license.
        
Keywords: asyncio,aiohttp,ipfs
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Intended Audience :: Developers
Classifier: Development Status :: 4 - Beta
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Topic :: System :: Filesystems
