simvue-io / simvue-io/python-api
Be Consistent in Python API Print Outs
Offen
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 4
- Forks
- 1
- Ø Merge
- 5 T. 8 Std.
- Gemergte PRs (30 T.)
- 4
Beschreibung
Currently the Python API has two forms of information display:
- Logging with the built-in
loggingPython module. - Custom printouts which are displayed in colour using
click.
The issue here is that logging statements are sent as Events to the server, but these printouts are not.
Discussion needs to be had on how to handle these two cases.
Beitragsleitfaden
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
Beginne damit, die Verwendungen des integrierten logging-Moduls und der farbigen Click-basierten Ausgaben der Python API zu lesen. Vergleiche, welche Meldungen zu server Events werden und welche nicht, und kläre anschließend die vorgesehene Behandlung beider Fälle, bevor du Abschlusskriterien definierst.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- api, backend-api-design
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 25/100