macadmins / macadmins/jamf-pro-sdk-python
[Feedback] src/jamf_pro_sdk/clients/pro_api/__init__.py may get unwieldy
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 69
- Forks
- 16
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Lies src/jamf_pro_sdk/clients/pro_api/init.py und verfolge, wie die vorhandenen Endpoint-Funktionen über client.pro_api verfügbar gemacht werden. Definiere die Modulstruktur und die Kompatibilitätserwartungen für die Gruppierung von Endpoints wie computer_v1 und überprüfe anschließend, dass die resultierende Client-API dem vereinbarten Design entspricht.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- api
- Issue-Typ
- Refactoring
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100