Skip to main content

Python 3 async client for interacting with the IPFS HTTP API

Project description

Async IPFS API Client

Build Status Docs Status Codecov Status

Documentation can be found at aioipfs-api.readthedocs.org.

Installation

pip install aioipfs-api

Usage

This assumes you have a working familiarity with asyncio.

import asyncio
from aioipfs_api.client import Client

async def main():
    async with Client() as client:
        # print the readme
        async with client.cat("QmYwAPJzv5CZsnA625s3Xf2nemtYgPpHdWEz79ojWnPbdG/readme") as f:
            print(await f.text())

        # add a directory
        print(await client.add('/some/dir/path'))

loop = asyncio.get_event_loop()
loop.run_until_complete(main())

Logging

This library uses the standard Python logging library. To see debut output printed to STDOUT, for instance, use:

import logging

log = logging.getLogger('aioipfs_api')
log.setLevel(logging.DEBUG)
log.addHandler(logging.StreamHandler())

Running Tests

To run tests:

pip install -r dev-requirements.txt
python -m unittest

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aioipfs-api-0.1.3.tar.gz (13.7 kB view hashes)

Uploaded source

Built Distribution

aioipfs_api-0.1.3-py3-none-any.whl (15.5 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page