Metadata-Version: 2.1
Name: edgeberry
Version: 0.1.2
Summary: Python SDK for interfacing applications with Edgeberry
Home-page: https://github.com/Edgeberry/Edgeberry-Python-SDK
Author: Sanne 'SpuQ' Santens
Author-email: sanne.santens@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: pydbus
Requires-Dist: PyGObject

![Edgeberry Banner](https://raw.githubusercontent.com/Edgeberry/.github/main/brand/Edgeberry_banner_SDK.png)

<img src="https://s3.dualstack.us-east-2.amazonaws.com/pythondotorg-assets/media/community/logos/python-logo-only.png" align="right" width="10%"/>

The **Edgeberry Python SDK** is a software library to facilitate communication between Python application and the **Edgeberry Device Software**. The Edgeberry Python SDK interacts with the Edgeberry Device Software throught the D-Bus API.

<br clear="right"/>

## Usage
Install the package using `pip`
```sh
pip install edgeberry
```
Import the library in your application
```python
from edgeberry import Edgeberry
from edgeberry import EdgeberryCloudConnect

edgeberry = Edgeberry()
cloudConnect = EdgeberryCloudConnect()
```
Available methods
```python
edgeberry.set_status("level", "message")
edgeberry.set_application_info("name", "version", "description")

cloudConnect.send_message("message")
```

## On-device development

Using `Visual Studio Code`, we can remotely develop code on our Edgeberry device using the `Remote-SSH` extension:
```
1) Open VSCode
2) Navigate to 'Extensions' (Ctrl+Shift+x)
3) Search and install the 'Remote-SSH' extension
```
When the extension is installed, connect to the device
```
4) View > Command Palette... (Ctrl+Shift+p)
5) Remote-SSH: Connect to host...
6) <user>@<host>
7) <password>
```
The VSCode server is automatically installed. Now you can develop directly on the device.

## License & Collaboration
**Copyright© 2024 Sanne 'SpuQ' Santens**. The Edgeberry Python SDK is licensed under the **[MIT License](LICENSE.txt)**. The [Rules & Guidelines](https://github.com/Edgeberry/.github/blob/main/brand/Edgeberry_Trademark_Rules_and_Guidelines.md) apply to the usage of the Edgeberry™ brand.

### Collaboration

If you'd like to contribute to this project, please follow these guidelines:
1. Fork the repository and create your branch from `main`.
2. Make your changes and ensure they adhere to the project's coding style and conventions.
3. Test your changes thoroughly.
4. Ensure your commits are descriptive and well-documented.
5. Open a pull request, describing the changes you've made and the problem or feature they address.
