9-10 May | Open Source in Energy Access Symposium Hackathon
Stack: Python, either JS or PHP
Helpful experiences: Library programming and management, CI/CD pipelines
Abstract: The OpenPAYGO suite currently provides only a Python library. Libraries in other programming languages whould increase and enhance the adaptability of the OpenPAYGO ecosystem. As such, they should be published to common, language-specific package repositories (for example, NPM for JS, packagist for PHP, etc…)
The goal of this challenge is to make the OpenPAYGO functionality available in other programming languages. JS and PHP have been discussed and raised in the community in the past, but if the participants see a need for other relevant languages, this is great as well.
Note: The OpenPAYGO library encompasses different features of the OpenPAYGO ecosystem, like Token or Metrics. The focus of the workgroup should be the Token. Adding other OpenPAYGO features could be subject to future improvements outside of this hackathon.
Note
In this repository we are focusing on JavaScript implementation It is perfectly fine to also port it to other languages if participants bring expertise. Repositories will be created on the fly in this case.
Like other challenges, the outcome of this one depends on the actual priorities and skill sets brought to the team. A minimum expected outcome, however, is: One draft of a library in one additional relevant language, a roadmap, and a detailed to-do list of steps required to get to a final and usable level.
A non-exclusive list would look like this
- Extracting test cases for all Token modes from the Python library (https://github.com/EnAccess/OpenPAYGO-Token/tree/main/tests)
- Implement the OpenPAYGO Token algorithm in JavaScript
- Add test cases based on the result of 1.
- Integrate CI/CD pipeline to release the library to NPM
Bonus outcome: If the chosen language is JavaScript: Create a small static (!) website which can be used to generate OpenPAYGO Tokens for a testing use-case. The result should be similar to the example from Victron: https://payg.victronenergy.com/ (however Tokens should be computed client side, not server side like in the Victron case).
- Join the OSEAS24 Discord server: https://community.oseas.org/
- Introduce yourself in #introductions channel and join this topic’s channel
- Confirm you have access to the following Repos
- For physical participants: Bring a computer (and required Adapters) for some hacking 🤖🧑💻
- Read the documentation
Contact person(s): Vivien / Daniel