DOC: Windows api key #252
DOC: Windows api key #252
Conversation
stephen-hoover
left a comment
stephen-hoover
left a comment
There was a problem hiding this comment.
Thank you for adding this documentation! This is helpful. Apart from inline suggestions, you should also add a note in the changelog.
README.rst
Outdated
| 5. Install the package:: | ||
| 2. Source your ``.bash_profile`` (or restart your terminal). | ||
|
|
||
| Windows |
There was a problem hiding this comment.
I think this applies to Windows 10 and possibly Windows 7. Is XP the same?
There was a problem hiding this comment.
I'm not sure, I've only looked at Windows 10. I'm going to tag this as Windows 10 so it's clear, but I don't want to hold up this PR because it might take some time to track down Windows 7 and XP boxes.
README.rst
Outdated
| 1. Navigate to ``Settings`` -> type "environment" in search bar -> | ||
| ``Edit environment variables for your account``. This can also be found | ||
| in ``System Properties`` -> ``Advanced`` -> ``Environment Variables...``. | ||
| 2. If ``CIVIS_API_KEY`` already exists in the list of environment variables, |
There was a problem hiding this comment.
I believe there are two lists of environment variables, "User variables" and "System variables", yes? I think we should tell users to add their API key to the user variables.
There was a problem hiding this comment.
Agreed. I'll add a note.
| client = civis.APIClient() | ||
| print(client.users.list_me()['username']) | ||
| If ``civis-python`` was installed correctly, this will print your Civis |
README.rst
Outdated
| API Keys | ||
| -------- | ||
|
|
||
| Usage of ``civis-python`` requires a valid Civis API key, which can be created |
There was a problem hiding this comment.
"Civis API key" -> "Civis Platform API key"?
| 5. Install the package:: | ||
| 2. Source your ``.bash_profile`` (or restart your terminal). | ||
|
|
||
| Windows 10 |
There was a problem hiding this comment.
It might be worth mentioning https://docs.microsoft.com/en-us/windows/wsl/install-win10, which in my opinion is the best way to use python in windows.
There was a problem hiding this comment.
I suspect users will already have a workflow for python on Windows before they install civis. This is pretty cool, though.
3 participants
This add instructions for adding the environmental variable
CIVIS_API_KEYin Windows.