grants icon indicating copy to clipboard operation
grants copied to clipboard

Helium Official Python Library

Open jcronyn opened this issue 3 years ago • 3 comments

Project:

Official Helium API Python Library

Elevator Pitch:

Currently there is a JS library for the Helium API but no Python library. Adding this as an officially supported library would lower the barrier to entry for Python developers and allow a new community to get involved in the development of API tooling.

Total fiat/hnt ask:

$50,000 HNT

Name and Address:

Crypto Balloon LLC - 3712 Ringgold Road #185, Chattanooga, TN 37412

Team or Project website:

www.cryptoballoon.net

Code Repos of team or key applicants:

Joe Cronyn

Joshua Miller

Project Details:

The Helium community will benefit from having an official Python library.

  • Python is arguably the most popular language in the world
  • As the "second best language at everything", it will open up Helium API integration opportunities
  • Lower the barrier of entry to developers familiar with Python that want to integrate with the Helium APIs
  • Enable API use in future DeWi grants and Helium network projects

The final deliverable for this project will be a Python library that meets the following criteria.

  • Leverage the Helium API's Open API Specification to generate initial client stubs
  • Full feature parity with JS SDK https://github.com/helium/helium-js
    • Excluding @helium/crypto-react-native (not applicable)
  • Meet all python packaging standards
  • Automated continuous integration and package deployment
  • Fully tested with adequate code coverage and documentation
  • Would advise placing under helium account as the official open source Python API Library.

Roadmap:

Milestone + Date Deliverable Summary Cost
MS1, Q1-2022 Build basic client using Open API Spec Using the Helium API's Open API Specification, we will create a basic stub library for Python and wire it up as a usable package. 10,000 USD
MS2, Q2-2022 Add functionality to meet JS SDK parity Research and build on client from MS1 to bring into feature parity with JS SDK 25,000 USD
MS3, Q2/Q3-2022 MVP Delivery - Complete any remaining other tasks (CI/CD, Testing, Etc.) Python library completed and ready for community stewardship. All CI/CD and other goals completed and ready for final delivery. 15,000 USD

jcronyn avatar Dec 13 '21 22:12 jcronyn

Hey there, I've been working on https://github.com/ashdwilson/helium-python since late November, and I've already knocked out many of the deliverables. What do you think about working together and delivering early?

ashdwilson avatar Dec 29 '21 01:12 ashdwilson

@ashdwilson Looks like you've made a lot of progress recently since we opened this grant request which is awesome! We reviewed the landscape of python projects prior to presenting this grant but most had been abandoned and weren't in a good place and your repo was new enough that we weren't sure of the intended trajectory. I've sent you a connection request on LI so we can exchange info to chat over discord so we can knock out a lot of the questions about where we see this going faster.

thecardcheat avatar Dec 29 '21 18:12 thecardcheat

https://github.com/ashdwilson/helium-python has been removed and #28 withdrawn @JessmFromEarth and Ash has let us know his availability to contribute is not definite.

thecardcheat avatar Jan 01 '22 22:01 thecardcheat