ydb-platform / ydb-platform/ydb-python-sdk

Documentation suggest env auth, while it's already deprecated

Open
#191 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
102
Forks
75
Avg merge
1d 23h
Merged PRs (30d)
13

Description

In python-sdk documentions it's recommended to use deprecated env auth:

/home/eivanov89/.local/lib/python3.8/site-packages/ydb/auth_helpers.py:22: UserWarning: using construct_credentials_from_environ method for credentials instantiation is deprecated and will be removed in the future major releases. Please instantialize credentials by default or provide correct credentials instance to the Driver.

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 with the Python SDK documentation at the linked YDB page and locate the example recommending environment-based authentication. Update that recommendation to use the non-deprecated credential instantiation described in the warning. Done means the example no longer recommends construct_credentials_from_environ.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.