Skip to content
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.

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

Add documentation section on client authentication #6998

Merged
merged 10 commits into from
Oct 16, 2022
Merged

Add documentation section on client authentication #6998

merged 10 commits into from
Oct 16, 2022

Conversation

faph
Copy link
Contributor

@faph faph commented Oct 3, 2022

What do these changes do?

Adds a dedicated section on client authentication using the auth argument for HTTP Basic Auth. Also explains how to configure other authentication flows including periodic renewal of credentials.

Are there changes in behavior for the user?

No. Just makes it easier for developers to access authentication aiohttp features. Avoids users asking questions like this: #6908

Related issue number

Issue #6915

Checklist

  • I think the code is well written
  • Unit tests for the changes exist
  • Documentation reflects the changes
  • If you provide code modification, please add yourself to CONTRIBUTORS.txt
    • The format is <Name> <Surname>.
    • Please keep alphabetical order, the file is sorted by names.
  • Add a new news fragment into the CHANGES folder
    • name it <issue_id>.<type> for example (588.bugfix)
    • if you don't have an issue_id change it to the pr id after creating the pr
    • ensure type is one of the following:
      • .feature: Signifying a new feature.
      • .bugfix: Signifying a bug fix.
      • .doc: Signifying a documentation improvement.
      • .removal: Signifying a deprecation or removal of public API.
      • .misc: A ticket has been closed, but it is not of interest to users.
    • Make sure to use full sentences with correct case and punctuation, for example: "Fix issue with non-ascii contents in doctest text files."

@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Oct 3, 2022
@faph
Copy link
Contributor Author

faph commented Oct 3, 2022

@Dreamsorcerer I am proposing this documentation enhancements, since there's been at least 2 people who were wondering how to do this recently. Let me know if you have any feedback.

@faph
Copy link
Contributor Author

faph commented Oct 3, 2022

@webknjaz @Dreamsorcerer Please authorize workflows when you have a minute.

@faph faph marked this pull request as ready for review October 3, 2022 09:39
@faph faph requested review from webknjaz and asvetlov as code owners October 3, 2022 09:39
docs/client_advanced.rst Outdated Show resolved Hide resolved
docs/client_advanced.rst Outdated Show resolved Hide resolved
docs/client_advanced.rst Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Oct 3, 2022

Codecov Report

Merging #6998 (2e43323) into master (da36728) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #6998   +/-   ##
=======================================
  Coverage   97.50%   97.50%           
=======================================
  Files         103      103           
  Lines       29957    29957           
  Branches     3633     3633           
=======================================
  Hits        29211    29211           
  Misses        567      567           
  Partials      179      179           
Flag Coverage Δ
CI-GHA 97.41% <ø> (ø)
OS-Linux 97.05% <ø> (ø)
OS-Windows 95.39% <ø> (ø)
OS-macOS 96.69% <ø> (ø)
Py-3.10.7 97.22% <ø> (+0.05%) ⬆️
Py-3.11.0-rc.2 96.56% <ø> (-0.06%) ⬇️
Py-3.7.14 96.88% <ø> (ø)
Py-3.7.9 95.28% <ø> (ø)
Py-3.8.10 95.17% <ø> (-0.01%) ⬇️
Py-3.8.14 96.78% <ø> (ø)
Py-3.9.13 95.17% <ø> (ø)
Py-3.9.14 96.79% <ø> (ø)
Py-pypy7.3.9 96.44% <ø> (ø)
VM-macos 96.69% <ø> (ø)
VM-ubuntu 97.05% <ø> (ø)
VM-windows 95.39% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

faph and others added 2 commits October 4, 2022 08:49
Co-authored-by: Sam Bull <aa6bs0@sambull.org>
@faph
Copy link
Contributor Author

faph commented Oct 4, 2022

@Dreamsorcerer @webknjaz Comments addressed, please authorize pipes and review.

@faph faph requested review from Dreamsorcerer and removed request for asvetlov and webknjaz October 4, 2022 10:12
@faph
Copy link
Contributor Author

faph commented Oct 5, 2022

@Dreamsorcerer Unlikely these failing tests on py 3.11 are related to the docs updates. Are we able to merge with failing tests? Or how do we resolve this?

@Dreamsorcerer
Copy link
Member

@Dreamsorcerer Unlikely these failing tests on py 3.11 are related to the docs updates. Are we able to merge with failing tests? Or how do we resolve this?

They don't block merging, they are marked as experimental.

Copy link
Member

@Dreamsorcerer Dreamsorcerer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks fine to me. @webknjaz Happy with adding this?

@faph
Copy link
Contributor Author

faph commented Oct 7, 2022

@webknjaz Nudge :)

@faph
Copy link
Contributor Author

faph commented Oct 9, 2022

@Dreamsorcerer any other maintainers beside @webknjaz who could approve this?

@faph
Copy link
Contributor Author

faph commented Oct 11, 2022

@asvetlov possibly?

@Dreamsorcerer
Copy link
Member

It's not like your changes will appear anywhere until we make a new release. There's no rush, we'll get back to it.

@faph
Copy link
Contributor Author

faph commented Oct 11, 2022

@Dreamsorcerer I appreciate that. However, to clear my head it would be nice if a simple doc change could be merged in a reasonable timescale.

I really would like to get back to the question how we could/should actually enhance the auth experience.

Just being able to close out PRs as soon as possible seems good practice. It also is encouraging for the community of contributors :)

@Dreamsorcerer Dreamsorcerer merged commit 981665a into aio-libs:master Oct 16, 2022
@faph faph deleted the docs/authentication-headers branch October 16, 2022 17:04
@faph
Copy link
Contributor Author

faph commented Oct 16, 2022

Thanks @Dreamsorcerer

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bot:chronographer:provided There is a change note present in this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants