livepeer / grants

⚠️ DEPRECATED ⚠️ Please visit the new homepage at https://grants.livepeer.org
43 stars 7 forks source link

[Open Livepeer Network] Livepeer Python SDK Development #216

Open livepeer-grants-bot opened 4 months ago

livepeer-grants-bot commented 4 months ago

Application by: avik_saikat

What is your project, and what problem does it solve?

The project aims to develop a Python SDK for the Livepeer API, providing Python developers with convenient access to Livepeer's features and functionalities. This Python SDK will enable developers to integrate Livepeer's capabilities into their Python applications seamlessly. This SDK will simplify the process of interacting with Livepeer's API.

Link to public GitHub repo (if applicable)

Link to demo website (if applicable)

Please describe in more detail why this proposal is valuable for the Livepeer ecosystem

This will benefit the Livepeer ecosystem by expanding its developer reach to Python programmers, thereby increasing the accessibility and usability of Livepeer's decentralized live video streaming services. The Python SDK will empower developers to easily integrate Livepeer's functionality into a wide range of Python-based applications, fostering innovation and growth within the ecosystem.

Please describe in details what your final deliverable for this project will be.

The expected deliverable at the conclusion of the grant time period is a fully functional Python SDK for Livepeer, including comprehensive documentation and usage examples. This SDK will enable Python developers to seamlessly integrate Livepeer's decentralized live video streaming capabilities into their applications.

How will this deliverable benefit the Livepeer ecosystem?

This will benefit the Livepeer ecosystem by expanding its developer reach to Python programmers, thereby increasing the accessibility and usability of Livepeer's decentralized live video streaming services. The Python SDK will empower developers to easily integrate Livepeer's functionality into a wide range of Python-based applications, fostering innovation and growth within the ecosystem.

Please break up your development work into a clear set of milestones

Number
Description
Deliverable
Amount
Start Date
End Date
1

Phase 1: Planning and Design

Milestone 1: Understanding Livepeer Studio API (Week 1-2)

Study Livepeer Studio API documentation

Identify key features and specifications for SDK integration

Budget: $1000

Milestone 2: SDK Architecture Design (Week 3-4)

Design the architecture of the Python SDK

Define Pythonic abstractions for Livepeer Studio API integration

Budget: $1500

Milestone 3: Environment Setup (Week 5)

Configure development environment

Set up tools for testing and continuous integration

Budget: $1000

Project setup & architecture design.

$3,500.00
3/8/2024 UTC
3/14/2024 UTC
2

Phase 2: Development and Testing

Milestone 4: Core SDK Development (Week 6-9)

Implement core features: resource retrieval, creation, deletion, update, and other operations

Develop functions for error handling and custom HTTP client configuration

Budget: $1500

Milestone 5: Integration Testing (Week 10-11)

Test SDK functionality with sample data and edge cases

Conduct integration testing with existing Python applications

Budget: $1500

Milestone 6: Documentation and Release (Week 12)

Create comprehensive documentation with usage examples and API reference

Prepare the Python SDK for release on Python Package Index (PyPI)

Budget: $1500

Final product.

$4,500.00
3/14/2024 UTC
4/4/2024 UTC

What is the total amount requested (in USD)?

8000

Specify your team's long-term plans to maintain this software and upgrade it over time

Our team's long-term plans involve actively maintaining the Python SDK for Livepeer by providing regular updates, addressing user feedback, and ensuring compatibility with future versions of Livepeer's API. We aim to foster a collaborative development community around the SDK, encouraging contributions from other developers and incorporating new features and improvements over time.

Please describe (in words) your team's relevant experience, and why you think you are the right team to build this project. You can cite your team's prior experience in similar domains, doing similar dev work, individual team members' backgrounds, etc.

@Aviksaikat [Smart Contract Auditor, Systems Security Engineer, Lead Python Developer] https://github.com/aviksaikat

Previous projects https://github.com/alienrobotninja/bee-py ( Ethereum Swarm Foundation) https://github.com/Aviksaikat/swarm-cid-py ( Ethereum Swarm Foundation)

Who is your target user group? How do you plan on getting your users to use this?

  1. We'll create user-friendly docs with installation guides and usage examples.
  2. Active involvement in blockchain and Python communities via forums and social media to promote SDK benefits.
  3. Collaboration with Livepeer ecosystem projects to enhance adoption and integration opportunities.

How did you learn about the Livepeer Grants Program?

Google

Was this project started at a hackathon or another web3 event? Which one?

No

Please include any additional information that you think would be useful in helping us to evaluate your proposal.