thingsboard / thingsboard/thingsboard-python-client-sdk
Module naming may cause issues & clashes with other python packages
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 130
- Forks
- 86
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
Installing tb-mqtt-client results in the following files in python's site-packages directory:
__init__.py
sdk_utils.py
tb_device_http.py
tb_device_mqtt.py
tb_gateway_mqtt.py
utils.py
This gives me a few concerns:
- The
__init__.pyfile at the top-level of site-packages may be imported automatically when anything else from that directory is imported. This could lead to issues if any content is added to this file. - The names
__init__.py,sdk_utils.pyandutils.pyare not very unique and may easily clash with modules from other Python packages.
I recommend moving these files into a single top-level module or prefixing the file names with something unique to prevent issues.
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Empieza inspeccionando la estructura del paquete y las referencias a init.py, sdk_utils.py, tb_device_http.py, tb_device_mqtt.py, tb_gateway_mqtt.py y utils.py; después comprueba cómo tb-mqtt-client los instala en site-packages. Se considera terminado cuando los archivos del SDK están contenidos en un módulo de nivel superior único o utilizan nombres únicos, sin romper las importaciones del paquete ni la instalación.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- api
- Tipo de issue
- Refactorización
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100