Update __init__.py files to properly export all public APIs

This commit is contained in:
MassiveBox 2025-11-01 00:44:29 +01:00
parent 735e5de328
commit e82ecadbb3
Signed by: massivebox
GPG key ID: 9B74D3A59181947D
7 changed files with 58 additions and 7 deletions

6
.idea/vcs.xml generated Normal file
View file

@ -0,0 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="VcsDirectoryMappings">
<mapping directory="$PROJECT_DIR$" vcs="Git" />
</component>
</project>

View file

@ -44,11 +44,11 @@ python3 examples/send_bleak.py --no-optimize ~/path/to/image.png # Without dithe
## ⚙️ Components ## ⚙️ Components
1. **BLE Interface** ([ble/](file:///home/massive/Dev/gicisky/ble/)): Handles Bluetooth Low Energy communication 1. **BLE Interface** ([ble/](ble)): Handles Bluetooth Low Energy communication
2. **Core Protocol** ([core/](file:///home/massive/Dev/gicisky/core/)): Implements the Gicisky communication protocol, independent of the Bluetooth library 2. **Core Protocol** ([core/](core)): Implements the Gicisky communication protocol, independent of the Bluetooth library
3. **Image Processing** ([image/](file:///home/massive/Dev/gicisky/image/)): `conversion` formats images to the Gicisky format, `optimizer` (optional) uses 3. **Image Processing** ([image/](image)): `conversion` formats images to the Gicisky format, `optimizer` (optional) uses
dithering and letterboxing for better results dithering and letterboxing for better results
4. **Logging** ([logger/](file:///home/massive/Dev/gicisky/logger/)): Provides detailed logging capabilities 4. **Logging** ([logger/](logger)): Provides detailed logging capabilities
## 🧱 Requirements ## 🧱 Requirements

View file

@ -3,5 +3,18 @@ Gicisky - A Python library for interacting with Gicisky electronic ink display t
""" """
__version__ = "0.1.0" __version__ = "0.1.0"
__author__ = "Your Name" __author__ = "MassiveBox"
__email__ = "your.email@example.com" __email__ = "box@massive.box"
# Import all public APIs
from ble import *
from core import *
from image import *
from logger import *
# Define what gets imported with "from gicisky import *"
__all__ = []
__all__.extend(ble.__all__)
__all__.extend(core.__all__)
__all__.extend(image.__all__)
__all__.extend(logger.__all__)

View file

@ -0,0 +1,8 @@
from .bleak import BleakBackend
from .interface import BLEInterface, Advertisement
__all__ = [
"BleakBackend",
"BLEInterface",
"Advertisement"
]

View file

@ -0,0 +1,11 @@
from .advertisement import parse_advertisement, DeviceData
from .protocol import GiciskyProtocol, SERVICE_UUID, CHAR_CMD_UUID, CHAR_IMG_UUID
__all__ = [
"parse_advertisement",
"DeviceData",
"GiciskyProtocol",
"SERVICE_UUID",
"CHAR_CMD_UUID",
"CHAR_IMG_UUID"
]

View file

@ -1,3 +1,10 @@
from .optimizer import optimize from .optimizer import optimize
from .conversion import convert_to_gicisky_bytes, DEVICE_SPECS, DeviceSpec, ModelId
__all__ = ["optimize"] __all__ = [
"optimize",
"convert_to_gicisky_bytes",
"DEVICE_SPECS",
"DeviceSpec",
"ModelId"
]

View file

@ -0,0 +1,6 @@
from .logger import GiciskyLogger, LogCategory
__all__ = [
"GiciskyLogger",
"LogCategory"
]