Skip to content

PYTHON-3474 Improve documentation about credential handling #1080

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
blink1073 merged 3 commits into from
Oct 18, 2022
Merged

PYTHON-3474 Improve documentation about credential handling #1080

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
55c44e2
PYTHON-3474 Improve documentation about credential handling
blink1073 Oct 17, 2022
30b9043
add explanatory note
blink1073 Oct 17, 2022
a97a8ce
address review
blink1073 Oct 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions doc/changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
Changelog
=========

Changes in Version 4.3
----------------------
Changes in Version 4.3 (4.3.2)
------------------------------

Note: We withheld uploading tags 4.3.0 and 4.3.1 to PyPI due to a
version handling error and a necessary documentation update.

`dnspython <https://pypi.python.org/pypi/dnspython>`_ is now a required
dependency. This change makes PyMongo easier to install for use with "mongodb+srv://"
Expand Down
9 changes: 5 additions & 4 deletions doc/examples/authentication.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,11 +268,12 @@ or the local EC2 or ECS endpoint. The order in which the client searches for
when using ``pymongo_auth_aws>=1.1.0``.

Because we are now using ``boto3`` to handle credentials, the order and
locations of credentials are slightly different from previous versions.
Particularly, if you have a shared AWS credentials or config file,
locations of credentials are slightly different from before. Particularly,
if you have a shared AWS credentials or config file,
then those credentials will be used by default if AWS auth environment
variables are not set. To override this behavior, set ``AWS_PROFILE=""`` in
your shell or add ``os.environ["AWS_PROFILE"] = ""`` to your script or
variables are not set. To override this behavior, set
``AWS_SHARED_CREDENTIALS_FILE=""`` in your shell or add
``os.environ["AWS_SHARED_CREDENTIALS_FILE"] = ""`` to your script or
application. Alternatively, you can create an AWS profile specifically for
your MongoDB credentials and set ``AWS_PROFILE`` to that profile name.

Expand Down