Skip to main content

ipfsspec

A readonly implementation of fsspec for IPFS.

Installation

You can install ipfsspec directly from git with the following command:

pip install ipfsspec

Usage

This project is currently very rudimentaty. It is not yet optimized for efficiency and is not yet feature complete. However it should be enough to list directory contents and to retrieve files from ipfs:// resources via fsspec. A simple hello worlds would look like:

import fsspec

with fsspec.open("ipfs://QmZ4tDuvesekSs4qM5ZBKpXiZGun7S2CYtEZRB3DYXkjGx", "r") as f:
    print(f.read())

The current implementation uses a HTTP gateway to access the data. It uses IPIP-280 to determine which gateway to use. If you have a current installation of an IPFS node (e.g. kubo, IPFS Desktop etc...), you should be fine. In case you want to use a different gateway, you can use any of the methods specified in IPIP-280, e.g.:

  • create the file ~/.ipfs/gateway with the gateway address as first line
  • define the environment variable IPFS_GATEWAY to the gateway address
  • create the file /etc/ipfs/gateway with the gateway address as first line

No matter which option you use, the gateway has to be specified as an HTTP(S) url, e.g.: http://127.0.0.1:8080.

Release files for ipfsspec 0.6.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ipfsspec 0.6.0
File Size Uploaded
ipfsspec-0.6.0.tar.gz 15.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ipfsspec 0.6.0
File Interpreter ABI Platform
ipfsspec-0.6.0-py3-none-any.whl Python 3 none any Details

Total release size: 26.5 kB

Release files / ipfsspec-0.6.0.tar.gz

Download URL ipfsspec-0.6.0.tar.gz
Size 15.3 kB
Tags Source
SHA-256 checksum
How to use checksums
1c6c2e569560a038eaa9b8a9263d78eb00d0a7d97edbbfdeb872273d687545c0
BLAKE2b-256 checksum
How to use checksums
14302eacb1802e525832634843cc36fe43b0d0b6799132f58d3186bcf94c7d27
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.3

Release files / ipfsspec-0.6.0-py3-none-any.whl

Download URL ipfsspec-0.6.0-py3-none-any.whl
Size 11.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f13b4ce6d822d3f591adfb4b0cb7182da5f87d7c4afe4d6b48e4219dd1dfc3e5
BLAKE2b-256 checksum
How to use checksums
b6c356b266a5bca72d6a7104d5b6da67bec7a87381f6f4e52677fb469442474c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.3

Release history Release notifications | RSS feed

This release

0.6.0 This release

2 release files

0.5.3

2 release files

0.5.2

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page