ipfsspec

Name	ipfsspec JSON
Version	0.5.3 JSON
	download
home_page	None
Summary	readonly implementation of fsspec for IPFS
upload_time	2024-09-26 14:21:58
maintainer	None
docs_url	None
author	None
requires_python	>=3.8
license	MIT
keywords	fsspec ipfs filesystem
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # ipfsspec

A readonly implementation of fsspec for IPFS.

## Installation

You can install `ipfsspec` directly from git with the following command:
```bash
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:

```python
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](https://github.com/ipfs/specs/pull/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`.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "ipfsspec",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "fsspec, IPFS, filesystem",
    "author": null,
    "author_email": "Tobias K\u00f6lling <tobias.koelling@mpimet.mpg.de>",
    "download_url": "https://files.pythonhosted.org/packages/ee/a4/a0c937bd5bca1bd046fe357be8fda7888043599590437a8d6061ac268562/ipfsspec-0.5.3.tar.gz",
    "platform": null,
    "description": "# ipfsspec\n\nA readonly implementation of fsspec for IPFS.\n\n## Installation\n\nYou can install `ipfsspec` directly from git with the following command:\n```bash\npip install ipfsspec\n```\n\n## Usage\n\nThis 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:\n\n```python\nimport fsspec\n\nwith fsspec.open(\"ipfs://QmZ4tDuvesekSs4qM5ZBKpXiZGun7S2CYtEZRB3DYXkjGx\", \"r\") as f:\n    print(f.read())\n```\n\nThe current implementation uses a HTTP gateway to access the data. It uses [IPIP-280](https://github.com/ipfs/specs/pull/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.:\n\n* create the file `~/.ipfs/gateway` with the gateway address as first line\n* define the environment variable `IPFS_GATEWAY` to the gateway address\n* create the file `/etc/ipfs/gateway` with the gateway address as first line\n\nNo matter which option you use, the gateway has to be specified as an HTTP(S) url, e.g.: `http://127.0.0.1:8080`.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "readonly implementation of fsspec for IPFS",
    "version": "0.5.3",
    "project_urls": null,
    "split_keywords": [
        "fsspec",
        " ipfs",
        " filesystem"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8fbedebced7701fecd4cc62d928672a3f32953b56549315760841f4944718d15",
                "md5": "12ff81896ac96a36378a41a519d21600",
                "sha256": "a621803074e9e5b2ced2108e216035f40600a36487ed17a52314834e81633f11"
            },
            "downloads": -1,
            "filename": "ipfsspec-0.5.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "12ff81896ac96a36378a41a519d21600",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 8939,
            "upload_time": "2024-09-26T14:21:57",
            "upload_time_iso_8601": "2024-09-26T14:21:57.457743Z",
            "url": "https://files.pythonhosted.org/packages/8f/be/debced7701fecd4cc62d928672a3f32953b56549315760841f4944718d15/ipfsspec-0.5.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "eea4a0c937bd5bca1bd046fe357be8fda7888043599590437a8d6061ac268562",
                "md5": "0ac662c4beb17c68190b54112431e924",
                "sha256": "d90999b149c9e476e0459d92a70162e563583cda24b3359da036624326d36da4"
            },
            "downloads": -1,
            "filename": "ipfsspec-0.5.3.tar.gz",
            "has_sig": false,
            "md5_digest": "0ac662c4beb17c68190b54112431e924",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 12817,
            "upload_time": "2024-09-26T14:21:58",
            "upload_time_iso_8601": "2024-09-26T14:21:58.399507Z",
            "url": "https://files.pythonhosted.org/packages/ee/a4/a0c937bd5bca1bd046fe357be8fda7888043599590437a8d6061ac268562/ipfsspec-0.5.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-26 14:21:58",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "ipfsspec"
}