Make SAPI endpoint config option name(s) clearer
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 50/100
Research direction
Start by locating the configuration handling for the existing endpoint, metadata_api_endpoint, and leap_api_endpoint options and their environment variables. Trace how the SAPI endpoint is selected, then verify that solver_api_endpoint and DWAVE_SOLVER_API_ENDPOINT work while the existing endpoint aliases remain compatible; decide whether deprecation is included.
Written by the indexing model from the issue text.
Description
We currently support:
metadata_api_endpoint(file/kwarg) option andDWAVE_METADATA_API_ENDPOINT(env var)endpoint(file/kwarg) option andDWAVE_API_ENDPOINT(env var) for specifying SolverAPI (SAPI) endpoint - legacy names back from the era when cloud-client worked only with SAPI.
And after #569:
leap_api_endpoint(file/kwarg) option andDWAVE_LEAP_API_ENDPOINT(env var).
For consistency, we should:
- add
solver_api_endpoint/DWAVE_SOLVER_API_ENDPOINToptions, and - make
endpoint/DWAVE_API_ENDPOINTaliases of these new SAPI endpoint options
Optionally:
- deprecate
endpoint/DWAVE_API_ENDPOINTaliases
- Dominant language
- Python
- Stars
- 63
- Forks
- 44
- Avg merge
- 9d 21h
- Merged PRs (30d)
- 1
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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.
More from dwavesystems/dwave-cloud-client
-
Add return typehints to sample_ functionsPossibly taken A pull request linked to this issue is open or already merged. Open
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
feature
Difficulty 5/5 Over a week Newbie friendliness 35/100
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
dwavesystems/dwave-cloud-client#748 · 1 reaction ·
-
feature
Difficulty 4/5 3-5 days Newbie friendliness 45/100
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
dwavesystems/dwave-cloud-client#738 · 1 comment ·
All issues in dwavesystems/dwave-cloud-client
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
zach-blumenfeld/aip#13 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 80/100
nathanmarlor/foxess_modbus#1287 ·
Maintainers usually reply within 4 days
-
bug good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
OpenLakeForge/openlakeforge#498 ·
Maintainers usually reply within 1 day
-
good first issue hacktoberfest help wanted python
Difficulty 2/5 1-3 hours Newbie friendliness 73/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 69/100
pollen-robotics/reachy_mini#1493 ·
Maintainers usually reply within 1 day