astarte-platform / astarte-platform/astarte-device-sdk-python

[API]: Unify Send API

Open
#207 0 comments 0 reactions 0 assignees View on GitHub
API breaking
Dominant language
Python
Stars
3
Forks
10
PR merge metrics
No merged PRs in 30d

Description

Currently each Astarte Device SDKs has a different name for the function that allows publishing data to an Astarte instance.

We want to unify the Send API across all SDKs to avoid confusion for the end user, who may use different SDKs for various use cases and could become disoriented.

All SDKs will implement the unified API for publishing data to an Astarte instance.

API for publishing a property value :

``` python
def set_property(...);

def unset_property(...);
```

API for publishing a individual value :

``` python
def send_individual(...);
```

API for publishing a object value :

``` python
def send_object(...);
```

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the current publishing methods in the Python SDK and compare them with the proposed set_property, unset_property, send_individual, and send_object API. Check how each existing operation is exposed and tested. Done means the Python SDK implements the unified publishing API consistently, with its tests updated to cover the new method names.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.