Skip to content

Conversation

@jonkeane
Copy link
Collaborator

The string isn't actually an issue (since it's made up), but it was caught in secret scanning. IMO it's nice(r) to be explicit about what one puts there (hence {your API key} rather than a random string that could (in shape at least) be an API key, but have the person figure out that's the thing that goes there.

I also fixed up some really wonky quotes. They were in comments so I'm not surprised nothing complained about this, but the lacking a quote and then one having double was really strange!

@jonkeane jonkeane requested a review from tdstein as a code owner October 14, 2025 13:10
@github-actions
Copy link

github-actions bot commented Oct 14, 2025

☂️ Python Coverage

current status: ✅

Overall Coverage

Lines Covered Coverage Threshold Status
1998 1884 94% 0% 🟢

New Files

No new covered files...

Modified Files

File Coverage Status
src/posit/connect/client.py 99% 🟢
TOTAL 99% 🟢

updated for commit: ad9ad2b by action🐍

@jonkeane jonkeane requested review from amol- and marcosnav October 14, 2025 13:11
@jonkeane jonkeane changed the title Remove random string in examples, fix quotes docs: Remove random string in examples, fix quotes Oct 14, 2025
@jonkeane
Copy link
Collaborator Author

I've swapped over to os.getenv("CONNECT_API_KEY") since we want to encourage that (and not have API keys leak into people's history).

@jonkeane jonkeane merged commit 5546854 into main Oct 14, 2025
43 checks passed
@jonkeane jonkeane deleted the secret branch October 14, 2025 16:02
@tdstein
Copy link
Collaborator

tdstein commented Oct 14, 2025

os.getenv("CONNECT_API_KEY") is the default behavior, so maybe os.getenv("SOMEOTHERNAME") might be slightly more informational. But, it's fine to leave as is. Thanks for grabbing this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants