Metadata-Version: 2.1
Name: py-is-ipfs
Version: 0.0.5
Summary: Python library to identify valid IPFS resources
Home-page: https://github.com/Barabazs/py-is_ipfs
Author: Barabazs
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: py-cid (>=0.3.0<1.0.0)
Requires-Dist: py-multibase (<2.0.0,>=1.0.3)

# 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 Workflow Status](https://img.shields.io/github/workflow/status/Barabazs/py-is_ipfs/Test?label=Test&logo=github)

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
* [ ] URL
  * [x] IPFS
  * [ ] IPNS
* [ ] Subdomain
  * [x] IPFS
  * [ ] IPNS
* [ ] Path
* [ ] ...

## 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.


