From cdc057f8514d4d44522c220bfab09d046827cb2a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E4=BE=9D=E7=91=AA=E8=B2=93?= Date: Wed, 4 Jan 2023 21:29:12 +0800 Subject: [PATCH] Renamed the package from flask-digest-auth to Flask-DigestAuth, by the Flask recommended extension guidelines https://flask.palletsprojects.com/en/latest/extensiondev/. --- README.rst | 46 ++++++++++++++++++++-------------------- docs/source/conf.py | 4 ++-- docs/source/examples.rst | 8 +++---- docs/source/index.rst | 8 +++---- docs/source/intro.rst | 32 ++++++++++++++-------------- setup.cfg | 8 +++---- 6 files changed, 53 insertions(+), 53 deletions(-) diff --git a/README.rst b/README.rst index 52b2793..7c8f9c5 100644 --- a/README.rst +++ b/README.rst @@ -6,13 +6,13 @@ Flask HTTP Digest Authentication Description =========== -*Flask-Digest-Auth* is an `HTTP Digest Authentication`_ implementation +*Flask-DigestAuth* is an `HTTP Digest Authentication`_ implementation for Flask_ applications. It authenticates the user for the protected views. HTTP Digest Authentication is specified in `RFC 2617`_. -Refer to the full `Flask-Digest-Auth readthedocs documentation`_. +Refer to the full `Flask-DigestAuth readthedocs documentation`_. Why HTTP Digest Authentication? @@ -30,7 +30,7 @@ own challenge-response log in form, but then you are reinventing the wheels. If a pretty log in form is not critical to your project, HTTP Digest Authentication should be a good choice. -Flask-Digest-Auth works with Flask-Login_. Log in protection can be +Flask-DigestAuth works with Flask-Login_. Log in protection can be separated with the authentication mechanism. You can create protected Flask modules without knowing the actual authentication mechanisms. @@ -38,18 +38,18 @@ Flask modules without knowing the actual authentication mechanisms. Installation ============ -You can install Flask-Digest-Auth with ``pip``: +You can install Flask-DigestAuth with ``pip``: :: - pip install Flask-Digest-Auth + pip install Flask-DigestAuth You may also install the latest source from the -`Flask-Digest-Auth GitHub repository`_. +`Flask-DigestAuth GitHub repository`_. :: - pip install git+https://github.com/imacat/flask-digest-auth.git + pip install git+https://github.com/imacat/flask-digestauth.git Setting the Password @@ -70,14 +70,14 @@ you need to ask their password, to generate and store the new password hash. -Flask-Digest-Auth Alone -======================= +Flask-DigestAuth Alone +====================== -Flask-Digest-Auth can authenticate the users alone. +Flask-DigestAuth can authenticate the users alone. -Simple Applications with Flask-Digest-Auth Alone ------------------------------------------------- +Simple Applications with Flask-DigestAuth Alone +----------------------------------------------- In your ``my_app.py``: @@ -112,8 +112,8 @@ In your ``my_app.py``: return redirect(request.form.get("next")) -Larger Applications with ``create_app()`` with Flask-Digest-Auth Alone ----------------------------------------------------------------------- +Larger Applications with ``create_app()`` with Flask-DigestAuth Alone +--------------------------------------------------------------------- In your ``my_app/__init__.py``: @@ -169,19 +169,19 @@ In your ``my_app/views.py``: Flask-Login Integration ======================= -Flask-Digest-Auth works with Flask-Login_. You can write a Flask +Flask-DigestAuth works with Flask-Login_. You can write a Flask module that requires log in, without specifying how to log in. The application can use either HTTP Digest Authentication, or the log in forms, as needed. -To use Flask-Login with Flask-Digest-Auth, +To use Flask-Login with Flask-DigestAuth, ``login_manager.init_app(app)`` must be called before ``auth.init_app(app)``. The currently logged-in user can be retrieved at ``flask_login.current_user``, if any. -The views only depend on Flask-Login, but not the Flask-Digest-Auth. +The views only depend on Flask-Login, but not the Flask-DigestAuth. You can change the actual authentication mechanism without changing the views. @@ -293,7 +293,7 @@ mechanism without changing the views. Session Integration =================== -Flask-Digest-Auth features session integration. The user log in +Flask-DigestAuth features session integration. The user log in is remembered in the session. The authentication information is not requested again. This is different to the practice of the HTTP Digest Authentication, but is convenient for the log in accounting. @@ -315,14 +315,14 @@ logging the log in event, adding the log in counter, etc. Log Out ======= -Flask-Digest-Auth supports log out. The user will be prompted for the +Flask-DigestAuth supports log out. The user will be prompted for the new username and password. Test Client =========== -Flask-Digest-Auth comes with a test client that supports HTTP digest +Flask-DigestAuth comes with a test client that supports HTTP digest authentication. @@ -389,7 +389,7 @@ A pytest Test Copyright ========= - Copyright (c) 2022 imacat. + Copyright (c) 2022-2023 imacat. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. @@ -414,6 +414,6 @@ Authors .. _HTTP Digest Authentication: https://en.wikipedia.org/wiki/Digest_access_authentication .. _RFC 2617: https://www.rfc-editor.org/rfc/rfc2617 .. _Flask: https://flask.palletsprojects.com -.. _Flask-Digest-Auth GitHub repository: https://github.com/imacat/flask-digest-auth -.. _Flask-Digest-Auth readthedocs documentation: https://flask-digest-auth.readthedocs.io +.. _Flask-DigestAuth GitHub repository: https://github.com/imacat/flask-digestauth +.. _Flask-DigestAuth readthedocs documentation: https://flask-digestauth.readthedocs.io .. _Flask-Login: https://flask-login.readthedocs.io diff --git a/docs/source/conf.py b/docs/source/conf.py index 4b0abe3..2d15ea8 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -10,8 +10,8 @@ sys.path.insert(0, os.path.abspath('../../src/')) # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information -project = 'Flask-Digest-Auth' -copyright = '2022, imacat' +project = 'Flask-DigestAuth' +copyright = '2022-2023, imacat' author = 'imacat' release = '0.3.1' diff --git a/docs/source/examples.rst b/docs/source/examples.rst index 1caf865..c314537 100644 --- a/docs/source/examples.rst +++ b/docs/source/examples.rst @@ -4,8 +4,8 @@ Examples .. _example-alone-simple: -Simple Applications with Flask-Digest-Auth Alone ------------------------------------------------- +Simple Applications with Flask-DigestAuth Alone +----------------------------------------------- In your ``my_app.py``: @@ -42,8 +42,8 @@ In your ``my_app.py``: .. _example-alone-large: -Larger Applications with ``create_app()`` with Flask-Digest-Auth Alone ----------------------------------------------------------------------- +Larger Applications with ``create_app()`` with Flask-DigestAuth Alone +--------------------------------------------------------------------- In your ``my_app/__init__.py``: diff --git a/docs/source/index.rst b/docs/source/index.rst index 3fe1c6a..96c30ac 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,12 +1,12 @@ -.. Flask-Digest-Auth documentation master file, created by +.. Flask-DigestAuth documentation master file, created by sphinx-quickstart on Wed Dec 7 09:40:48 2022. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to Flask-Digest-Auth's documentation! -============================================= +Welcome to Flask-DigestAuth's documentation! +============================================ -*Flask-Digest-Auth* is an `HTTP Digest Authentication`_ implementation +*Flask-DigestAuth* is an `HTTP Digest Authentication`_ implementation for Flask_ applications. It authenticates the user for the protected views. diff --git a/docs/source/intro.rst b/docs/source/intro.rst index d5eeb5d..f5c9207 100644 --- a/docs/source/intro.rst +++ b/docs/source/intro.rst @@ -2,7 +2,7 @@ Introduction ============ -*Flask-Digest-Auth* is an `HTTP Digest Authentication`_ implementation +*Flask-DigestAuth* is an `HTTP Digest Authentication`_ implementation for Flask_ applications. It authenticates the user for the protected views. @@ -24,7 +24,7 @@ own challenge-response log in form, but then you are reinventing the wheels. If a pretty log in form is not critical to your project, HTTP Digest Authentication should be a good choice. -Flask-Digest-Auth works with Flask-Login_. Log in protection can be +Flask-DigestAuth works with Flask-Login_. Log in protection can be separated with the authentication mechanism. You can create protected Flask modules without knowing the actual authentication mechanisms. @@ -32,18 +32,18 @@ Flask modules without knowing the actual authentication mechanisms. Installation ------------ -You can install Flask-Digest-Auth with ``pip``: +You can install Flask-DigestAuth with ``pip``: :: - pip install Flask-Digest-Auth + pip install Flask-DigestAuth You may also install the latest source from the -`Flask-Digest-Auth GitHub repository`_. +`Flask-DigestAuth GitHub repository`_. :: - pip install git+https://github.com/imacat/flask-digest-auth.git + pip install git+https://github.com/imacat/flask-digestauth.git Setting the Password @@ -66,10 +66,10 @@ hash. See :func:`flask_digest_auth.algo.make_password_hash`. -Flask-Digest-Auth Alone ------------------------ +Flask-DigestAuth Alone +---------------------- -Flask-Digest-Auth can authenticate the users alone. +Flask-DigestAuth can authenticate the users alone. See :ref:`example-alone-simple` and :ref:`example-alone-large`. @@ -77,12 +77,12 @@ See :ref:`example-alone-simple` and :ref:`example-alone-large`. Flask-Login Integration ----------------------- -Flask-Digest-Auth works with Flask-Login_. You can write a Flask +Flask-DigestAuth works with Flask-Login_. You can write a Flask module that requires log in, without specifying how to log in. The application can use either HTTP Digest Authentication, or the log in forms, as needed. -To use Flask-Login with Flask-Digest-Auth, +To use Flask-Login with Flask-DigestAuth, ``login_manager.init_app(app)`` must be called before ``auth.init_app(app)``. @@ -92,7 +92,7 @@ The currently logged-in user can be retrieved at See :ref:`example-flask-login-simple` and :ref:`example-flask-login-large`. -The views only depend on Flask-Login, but not the Flask-Digest-Auth. +The views only depend on Flask-Login, but not the Flask-DigestAuth. You can change the actual authentication mechanism without changing the views. @@ -100,7 +100,7 @@ the views. Session Integration ------------------- -Flask-Digest-Auth features session integration. The user log in +Flask-DigestAuth features session integration. The user log in is remembered in the session. The authentication information is not requested again. This is different to the practice of the HTTP Digest Authentication, but is convenient for the log in accounting. @@ -124,7 +124,7 @@ See :meth:`flask_digest_auth.auth.DigestAuth.register_on_login`. Log Out ------- -Flask-Digest-Auth supports log out. The user will be prompted for the +Flask-DigestAuth supports log out. The user will be prompted for the new username and password. See :meth:`flask_digest_auth.auth.DigestAuth.logout`. @@ -133,7 +133,7 @@ See :meth:`flask_digest_auth.auth.DigestAuth.logout`. Test Client ----------- -Flask-Digest-Auth comes with a test client that supports HTTP digest +Flask-DigestAuth comes with a test client that supports HTTP digest authentication. See :class:`flask_digest_auth.test.Client`. @@ -145,4 +145,4 @@ Also see :ref:`example-unittest` and :ref:`example-pytest`. .. _RFC 2617: https://www.rfc-editor.org/rfc/rfc2617 .. _Flask: https://flask.palletsprojects.com .. _Flask-Login: https://flask-login.readthedocs.io -.. _Flask-Digest-Auth GitHub repository: https://github.com/imacat/flask-digest-auth +.. _Flask-DigestAuth GitHub repository: https://github.com/imacat/flask-digestauth diff --git a/setup.cfg b/setup.cfg index d2480e6..74847cd 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,7 +1,7 @@ # The Flask HTTP Digest Authentication Project. # Author: imacat@mail.imacat.idv.tw (imacat), 2022/11/23 -# Copyright (c) 2022 imacat. +# Copyright (c) 2022-2023 imacat. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -16,16 +16,16 @@ # limitations under the License. [metadata] -name = flask-digest-auth +name = Flask-DigestAuth version = 0.3.1 author = imacat author_email = imacat@mail.imacat.idv.tw description = The Flask HTTP Digest Authentication project. long_description = file: README.rst long_description_content_type = text/x-rst -url = https://github.com/imacat/flask-digest-auth +url = https://github.com/imacat/flask-digestauth project_urls = - Bug Tracker = https://github.com/imacat/flask-digest-auth/issues + Bug Tracker = https://github.com/imacat/flask-digestauth/issues classifiers = Programming Language :: Python :: 3 License :: OSI Approved :: Apache Software License