README.rst 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  1. Google Auth Python Library
  2. ==========================
  3. |pypi|
  4. This library simplifies using Google's various server-to-server authentication
  5. mechanisms to access Google APIs.
  6. .. |pypi| image:: https://img.shields.io/pypi/v/google-auth.svg
  7. :target: https://pypi.python.org/pypi/google-auth
  8. Installing
  9. ----------
  10. You can install using `pip`_::
  11. $ pip install google-auth
  12. .. _pip: https://pip.pypa.io/en/stable/
  13. For more information on setting up your Python development environment, please refer to `Python Development Environment Setup Guide`_ for Google Cloud Platform.
  14. .. _`Python Development Environment Setup Guide`: https://cloud.google.com/python/docs/setup
  15. Extras
  16. ------
  17. google-auth has few extras that you can install. For example::
  18. $ pip install google-auth[pyopenssl]
  19. Note that the extras pyopenssl and enterprise_cert should not be used together because they use conflicting versions of `cryptography`_.
  20. .. _`cryptography`: https://cryptography.io/en/latest/
  21. Supported Python Versions
  22. ^^^^^^^^^^^^^^^^^^^^^^^^^
  23. Python >= 3.7
  24. **NOTE**:
  25. Python 3.7 was marked as `unsupported`_ by the python community in June 2023.
  26. We recommend that all developers upgrade to Python 3.8 and newer as soon as
  27. they can. Support for Python 3.7 will be removed from this library after
  28. January 1 2024. Previous releases that support Python 3.7 will continue to be available
  29. for download, but releases after January 1 2024 will only target Python 3.8 and
  30. newer.
  31. .. _unsupported: https://devguide.python.org/versions/#unsupported-versions
  32. Unsupported Python Versions
  33. ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  34. - Python == 2.7: The last version of this library with support for Python 2.7
  35. was `google.auth == 1.34.0`.
  36. - Python 3.5: The last version of this library with support for Python 3.5
  37. was `google.auth == 1.23.0`.
  38. - Python 3.6: The last version of this library with support for Python 3.6
  39. was `google.auth == 2.22.0`.
  40. Documentation
  41. -------------
  42. Google Auth Python Library has usage and reference documentation at https://googleapis.dev/python/google-auth/latest/index.html.
  43. Current Maintainers
  44. -------------------
  45. - googleapis-auth@google.com
  46. Authors
  47. -------
  48. - `@theacodes <https://github.com/theacodes>`_ (Thea Flowers)
  49. - `@dhermes <https://github.com/dhermes>`_ (Danny Hermes)
  50. - `@lukesneeringer <https://github.com/lukesneeringer>`_ (Luke Sneeringer)
  51. - `@busunkim96 <https://github.com/busunkim96>`_ (Bu Sun Kim)
  52. Contributing
  53. ------------
  54. Contributions to this library are always welcome and highly encouraged.
  55. See `CONTRIBUTING.rst`_ for more information on how to get started.
  56. .. _CONTRIBUTING.rst: https://github.com/googleapis/google-auth-library-python/blob/main/CONTRIBUTING.rst
  57. License
  58. -------
  59. Apache 2.0 - See `the LICENSE`_ for more information.
  60. .. _the LICENSE: https://github.com/googleapis/google-auth-library-python/blob/main/LICENSE