posit-dev / posit-dev/rsconnect-python

Provide an alternative to the `--api-key` flag when adding a new server nickname

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

Nobody has claimed this yet.

Dominant language
Python
Stars
37
Forks
28
Avg merge
1d 3h
Merged PRs (30d)
7

Description

Currently we can only supply a server api key to the add command using the -k flag. To prevent api keys from leaking through user's bash history, we should provide alternative methods of providing the api key.

It would be great if -k isn’t passed, we use getpass or similar to prompt for the API key. We'll also want to update our documentation to encourage users to go this route as a best-practice

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 at the CLI add command and inspect how the -k/--api-key option is handled, then review the existing documentation for adding a server nickname. Done means users can omit the flag and enter the API key securely through a getpass-style prompt, while the documentation recommends that approach.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, documentation, security
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.