https://github.com/barabazs/py-is_ipfs

py-is_ipfs is a Python library to identify valid IPFS resources.
https://github.com/barabazs/py-is_ipfs

cid decentralization ipfs ipns validation validation-library

Last synced: 26 days ago
JSON representation

py-is_ipfs is a Python library to identify valid IPFS resources.

• Host: GitHub
• URL: https://github.com/barabazs/py-is_ipfs
• Owner: Barabazs
• License: mit
• Created: 2022-03-09T09:11:54.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-14T11:21:21.000Z (12 months ago)
• Last Synced: 2024-10-16T06:16:00.748Z (7 months ago)
• Topics: cid, decentralization, ipfs, ipns, validation, validation-library
• Language: Python
• Homepage:
• Size: 52.7 KB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.MD
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# py-is_ipfs

[![Latest release](https://img.shields.io/pypi/v/py-is_ipfs?color=blue&label=release)](https://github.com/Barabazs/py-is_ipfs/releases/latest) ![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/barabazs/py-is_ipfs/.github%2Fworkflows%2Ftest.yml?logo=github&label=Tests)

py-is_ipfs is a Python library to identify valid IPFS resources.  

This project is a work in progress.

## Installation and usage

### Installation

py-is_ipfs is available on PyPI:

`python -m pip install py-is_ipfs`

### Usage

```python

from is_ipfs import Validator

print(Validator("QmYjtig7VJQ6XsnUjqqJvj7QaMcCAwtrgNdahSiFofrE7o").is_ipfs())

```

## Currently supported

* [x] CID

  * [x] v0

  * [x] v1

* [x] URL

  * [x] Path Gateway

    * [x] IPFS

    * [x] IPNS

  * [x] Subdomain Gateway

    * [x] IPFS

    * [x] IPNS

* [x] Path

  * [x] IPFS

  * [x] IPNS

* [x] Native URL

  * [x] IPFS

  * [x] IPNS

* [ ] ...

## License

[MIT](https://github.com/Barabazs/py-is_ipfs/blob/main/LICENSE)

## Acknowledgments

* [Protocol Labs](https://protocol.ai/) for funding this project with a micro grant.

* [ipfs-shipyard/is-ipfs](https://github.com/ipfs-shipyard/is-ipfs) for the heuristics implemented in JavaScript that this project used as a starting point.