macadmins / macadmins/jamf-pro-sdk-python
[Feedback] src/jamf_pro_sdk/clients/pro_api/__init__.py may get unwieldy
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 69
- Forks
- 16
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
Current
The current behaviour is to put all the functions for all the pro endpoints into the __init__.py file. I realise this allows calls like
ifrom jamf_pro_sdk import JamfProClient, BasicAuthProvider
client = JamfProClient(
server="dummy.jamfcloud.com",
credentials=BasicAuthProvider("username", "password")
)
all_computers = client.pro_api.get_computer_inventory_v1()
but when the number of endpoints gets high this file will grow to be difficult to deal with.
Proposed
I would propose that in the directory there could be a file computer_v1 which contains (among others) the function get_inventory then the call would be:
from jamf_pro_sdk import JamfProClient, BasicAuthProvider
client = JamfProClient(
server="dummy.jamfcloud.com",
credentials=BasicAuthProvider("username", "password")
)
all_computers = client.pro_api.computer_v1.get_inventory()
System Information
SDK version 4.0a
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
Lee src/jamf_pro_sdk/clients/pro_api/init.py y sigue cómo se exponen las funciones de endpoint existentes a través de client.pro_api. Define la estructura de módulos y las expectativas de compatibilidad para agrupar endpoints como computer_v1 y, a continuación, verifica que la API de cliente resultante coincida con el diseño acordado.
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
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100