simvue-io / simvue-io/python-api
Support for storing historical runs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 4
- Forks
- 1
- Avg merge
- 5d 8h
- Merged PRs (30d)
- 4
Description
Need to be able to manually specify creation, start and end times. To begin with:
Run.init()needs additional optionscreated,startedandendtime(or similar). If not set, the server will set them (as it does now).Run.close()needs an additional timestamp option for specifying the end time. If not set, the server will set it (as it does now).
This doesn't take into account people using the context manager.
When creating a run the JSON body in the POST can include created and started. If there are no metrics then it can also include endtime and status set to completed. When updating the status of the run to completed the JSON body can include endtime.
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 tracing Run.init() and Run.close(), then inspect how their JSON bodies are assembled for creating and completing runs. Account for the context-manager path and verify that optional historical timestamps preserve current server defaults while completed runs send the required status and end time.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100