Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MICROGRANT] py-is_ipfs #152

Closed
Barabazs opened this issue Mar 27, 2022 · 4 comments
Closed

[MICROGRANT] py-is_ipfs #152

Barabazs opened this issue Mar 27, 2022 · 4 comments
Assignees
Labels
type:microgrant Adoption Microgrant (https://github.com/protocol/ipfs-grants/blob/master/MICROGRANTS.md)

Comments

@Barabazs
Copy link

Barabazs commented Mar 27, 2022

1. What is your project? (max 100 words)

py-is_ipfs is a Python library (currently a WIP) to identify valid IPFS resources. The goal is to have a comprehensive method to be able to detect if X is a valid IPFS resource. X can be anything, URL, path, CID, hash, base encoded, ...

The user should not have to worry about what kind of IPFS-related resource they provide to the library. Whether it's a CID, or a complete URL, the library does the heavy lifting of identifying, converting and validating the input.
E.g. :

from is_ipfs import Validator

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

https://github.com/Barabazs/py-is_ipfs
https://pypi.org/project/py-is-ipfs/

2. How are you planning to improve this project? (max 200 words)

Currently only CIDs are detected and validated. I plan on adding support for URL (including subdomains), paths, IPNS and other related references to IPFS resources. This includes researching appropriate methods and specifications, the actual implementation, robust testing, writing documentation, ...

3. Will the work be Open Source?

Yes, the code is currently licensed under MIT.

4. If selected, do you agree to complete weekly updates and a grant report upon conclusion?

Yes

5. Does your proposal comply with our Community Code of Conduct?

Yes

6. Links and submissions

Additional questions:

  • For each team member(s), please list name, email, Github account, and role in the project.
Name Email Github Role
Barabazs [REDACTED] https://github.com/Barabazs Developer
@Barabazs Barabazs added the type:microgrant Adoption Microgrant (https://github.com/protocol/ipfs-grants/blob/master/MICROGRANTS.md) label Mar 27, 2022
@ErinOCon
Copy link
Collaborator

Hi @Barabazs, Thank you for your proposal. We will review this and get back to you, on this thread, with a status update or questions.

@Barabazs
Copy link
Author

Thank you @ErinOCon I'm looking forward to your feedback. 🙏

@ErinOCon
Copy link
Collaborator

Hi @Barabazs, This microgrant has been approved! Look out for an email to submit payment details.

@Barabazs
Copy link
Author

Hi @ErinOCon I'm having trouble finding where the weekly update should be posted. Can you advise please?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:microgrant Adoption Microgrant (https://github.com/protocol/ipfs-grants/blob/master/MICROGRANTS.md)
Projects
None yet
Development

No branches or pull requests

2 participants