simvue-io / simvue-io/python-api
Be Consistent in Python API Print Outs
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 4
- Forks
- 1
- Avg merge
- 5d 8h
- Merged PRs (30d)
- 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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the Python API's uses of the built-in logging module and Click-based coloured printouts. Compare which messages become server Events and which do not, then clarify the intended handling for both cases before defining completion criteria.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, backend-api-design
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100