ni / ni/nimi-python

Deprecate get_channel_name in nidcpower

Open
#1,586 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
128
Forks
110
Avg merge
5d 14h
Merged PRs (30d)
10

Description

Description of issue

As part of #1403 we need to deprecate get_channel_name. This also requires that #11584 be resolved.

Some additional considerations from Shreyas:

"Adding hapigen support is one part of it, the other part is to figure how we want to do the actual deprecation in nimi-python - Use DeprecationWarning or a third-party library like https://pypi.org/project/Deprecated/ or something else. Would be good to check with Python experts in the company."

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 reading the request to deprecate get_channel_name in nidcpower, then review linked issues #1403 and #1584 and the hapigen support mentioned in the issue. The open question is which deprecation approach to use, so consult Python experts before defining completion and implementation scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.