Project Name:
renterd alerts bot and renterd Python sdk
Name of the organization or individual submitting the proposal:
Patrick Gerard
Describe your project.
This project aims to provide a Python sdk to the community to interact with the renterd API in Python to simplify development in the future. Python is one of the most used programming languages and therefor a Python sdk is a must for such project to enable developers.
Furthermore, the Telegram API has great Python sdks which will then be used to build the modular renterd alerts bot. In the future I can imagine building a platform to monitor alerts and other metrics generated by the bot. The project will be delivered as docker-compose environment so it’s simple to use. A documentation on how to use the sdk and the bot will be provided and deployed via
Who benefits from your project?
Renterd user benefit with the alerts bot, which will be introduced with telegram in the first step. With the Python sdk, developers will have an efficient and standarized way to interact with the renterd API. This will onboard and enable other developers especially in the DevOps and SRE space where Python is a well-known language.
How does the project serve the Foundation’s mission of user-owned data?
By providing a self hosted solution with docker-compose.
Grant Specifics
Amount Requested: I am looking for $9000 for the product development and completion of the renterd alerts bot within 3 months.
The funds will enable me to focus on this project and build it in full-time without the need of freelancing somewhere else.
The amount will cover the following:
- Development: $7,000
- Python SDK - $4,500
- Telegram Bot with several modular functions to use - $2,500
- Operational Expenses: $2,000
- Documentation and examples - $1,000
- Testing and examples - $1000
Total = $9,000
- ** Milestone 1: $3000 - 15 January to 15 February**
- Development of the Python SDK with rough documentation
- Testing and bugfixes
- ** Milestone 1: $3,000 - 15 February to 15 March**
- Development of the Telegram Bot with rough documentation
- Testing and bugfixes
- ** Milestone 1: $3,000 - 15 March to 15 April**
- Intensive Testing and Bugfixes based on this will probably take 20 days
- The finalization of the documentation will take 10 days
I agree to accept grant funds in $USD via ACH or Wire, we agree to monthly grant payments starting with Development budget upon approval.
Timeline:
3 months from January 15, 2024, to April 15, 2024.
Potential Risks:
- The potential risk is an underestimation of the workload and a delay of delivery of the final product
Development Information
Will all of your project’s code be open-source?
Everything will be available on GitHub, fully open-source. If wanted including the progress-reports in a text form highlighting the issues I am facing.
Leave a link where code will be accessible for review.
Links(TBD.)
Do you agree to submit monthly progress reports?
Yes I do. I agree to report the progress here in the forum and if wanted on GitHub.
Contact Info
- Email: [email protected]
Other Preferred Contact Methods:
- Telegram: @gerrelintheberrel
I am happy to discuss and get feedback of you and enable other people to work with renterd! I can already think of further development’s after this project is done, so the development would be very modular in the best case so that a SMS-bot and other solutions could be added easily.