simvue-io / simvue-io/python-api
Be Consistent in Python API Print Outs
Ouverte
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 4
- Forks
- 1
- Merge moyen
- 5 j 8 h
- PR mergées (30 j)
- 4
Description
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.
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par lire les utilisations du module logging intégré et les affichages colorés basés sur Click de Python API. Comparez quels messages deviennent des server Events et lesquels ne le deviennent pas, puis clarifiez le traitement prévu pour les deux cas avant de définir les critères d'achèvement.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- api, backend-api-design
- Type d'issue
- Fonctionnalité
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 25/100