weaviate / weaviate/weaviate-python-client
Allow JSON-esque outputs through `str/repr`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 227
- Forks
- 151
- Avg merge
- 3d 14h
- Merged PRs (30d)
- 11
Description
Some users have queried how they can produce a JSON-type output in the v4 API.
It may be a nice QoL improvement if this was possible, e.g. through a str/repr function or something like a to_dict() method. Not yet clear what this should look like / how much information this should print to balance verbosity and convenience.
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 reviewing the v4 API objects that users would need to serialize and compare the proposed str/repr and to_dict() entry points. Define which information a JSON-esque output should include and how verbosity should be balanced. Done means the output format and scope are agreed and the chosen serialization behavior is covered by tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100