ni / ni/datastore-python

Improving Developer Experience by Simplifying Manual Integration Steps

Open
#106 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

example
Dominant language
Python
Stars
2
Forks
0
Avg merge
1d 14h
Merged PRs (30d)
6

Description

Pain Points:

  1. Strict dependencies across multiple metadata objects.
  2. Mismatched or incorrect IDs can lead to reference issues, while configuring aliases for every case adds extra maintenance effort.
  3. Large amount of boilerplate code required for basic operations.
  4. Manual client cleanup can lead to lingering connections, and clearer documentation with examples using with/using patterns would help prevent this. In addition, some users may prefer to instantiate clients at the start of a workflow and close them at the end, so guidance or best practices to manage long‑lived connections would also be valuable.

Impact:

  1. Heavy trial‑and‑error development, as users must repeatedly experiment to discover the correct object sequence and relationships.
  2. Huge development time.

Suggestions:

  1. Offer alias‑based referencing examples as an alternative to using raw IDs.
  2. Add examples of demonstrating APIs that support automatic cleanup.
  3. Practical examples with boilerplate‑free JSON integration patterns to simplify development and reduce complexity.

AB#3744864

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the Python API's existing integration examples and client lifecycle guidance. Document alias-based references, cleanup with with/using patterns, long-lived connection practices, and boilerplate-free JSON workflows. Done means the common integration sequence and resource-management choices are explained with practical examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
developer-experience, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.