zowe / zowe/zowe-client-python-sdk

Add note in readme suggesting `pip install -U --pre zowe.core-for-zowe-sdk[secrets]`

Open
#373 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

bug dev-doc priority-low severity-low
Dominant language
Python
Stars
44
Forks
38
Avg merge
1d 3h
Merged PRs (30d)
1

Description

Is your feature or enhancement request related to a problem or limitation? Please describe

On the PyPI page, we mention the optional secrets dependency for the core package, but we do not mention that step in the readme at the top level of this repo, which can lead users to wonder why their secure creds are not being loaded into a profile dict when using ProfileManager().load() from the core sdk.

Describe your enhancement idea

It would be helpful to include the command to install the secrets package in the top level readme in this repository (pip install -U --pre zowe.core-for-zowe-sdk[secrets]).

Describe alternatives you've considered

The alternative would be to have the bundle install the secrets package by default. Is there some reason not to include the secrets package in the bundle?

Provide any additional context

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

Open the repository's top-level README and locate the installation guidance for the core SDK and its optional secrets dependency. Add the command pip install -U --pre zowe.core-for-zowe-sdk[secrets], making clear that it is needed for secure credentials used by ProfileManager().load(). Done means the command and purpose are visible in the README.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.