From d717bd736992c3048189f90871075d7238a8ff42 Mon Sep 17 00:00:00 2001 From: PythonLinks <34622952+PythonLinks@users.noreply.github.com> Date: Tue, 19 Dec 2017 06:27:36 +0100 Subject: [PATCH 1/4] More Documentation You write wonderful detailed documentation. I added the docs for beginners, along with the link to the doc tests. --- README.txt | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.txt b/README.txt index a3b92de..1da2799 100644 --- a/README.txt +++ b/README.txt @@ -1,4 +1,18 @@ cromlech.sessions.jwt ##################### -HTTP server side sessions using JWT and Cookies. +This packaged provides HTTP server side sessions using JWT and Cookies. + +JWT is way of encrypting a json file, so that it can be used for secure communications. + +cromlech.sessions.jwt uses that encrypted information to keep a person logged in, even though HTTP is a stateless protocol. + +In the old days, we used a session cookie to identify a person, and kept the critical information in the local database. But this did not scale well. What if the next request hit a different server? What if you have a zope server and a chat server, the login information would have to be transferred over. What if you have a micro services architecture? So by encrypting the login credentials, and storing them in a cookie, along with time to live information everything works much better. + +You can read the detailed documentation [here](./src/cromlech/sessions/jwt/test_session.txt). + +In general Cromlech has great detailed documentation, but it is all hidden in the +doc tests. So always look for it there. + + + From 321b705308c6d79ac6648d2a553c2693fc95cd60 Mon Sep 17 00:00:00 2001 From: PythonLinks <34622952+PythonLinks@users.noreply.github.com> Date: Tue, 19 Dec 2017 06:31:55 +0100 Subject: [PATCH 2/4] Improved the documentation --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..029346a --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +cromlech.sessions.jwt +##################### + +This packaged provides HTTP server side sessions using JWT and Cookies. + +JWT is way of encrypting a json file, so that it can be used for secure communications. + +cromlech.sessions.jwt uses that encrypted information to keep a person logged in, even though HTTP is a stateless protocol. + +In the old days, we used a session cookie to identify a person, and kept the critical information in the local database. But this did not scale well. What if the next request hit a different server? What if you have a zope server and a chat server, the login information would have to be transferred over. What if you have a micro services architecture? So by encrypting the login credentials, and storing them in a cookie, along with time to live information everything works much better. + +You can read the detailed documentation [here](./src/cromlech/sessions/jwt/test_session.txt). + +In general Cromlech has great detailed documentation, but it is all hidden in the +doc tests. So always look for it there. + + From bcc18bf10f77d7f0ad4230e29091c71dfac42f68 Mon Sep 17 00:00:00 2001 From: PythonLinks <34622952+PythonLinks@users.noreply.github.com> Date: Tue, 19 Dec 2017 06:33:22 +0100 Subject: [PATCH 3/4] Basically I moved it to README.md So that the hyper link would work. --- README.txt | 18 ------------------ 1 file changed, 18 deletions(-) delete mode 100644 README.txt diff --git a/README.txt b/README.txt deleted file mode 100644 index 1da2799..0000000 --- a/README.txt +++ /dev/null @@ -1,18 +0,0 @@ -cromlech.sessions.jwt -##################### - -This packaged provides HTTP server side sessions using JWT and Cookies. - -JWT is way of encrypting a json file, so that it can be used for secure communications. - -cromlech.sessions.jwt uses that encrypted information to keep a person logged in, even though HTTP is a stateless protocol. - -In the old days, we used a session cookie to identify a person, and kept the critical information in the local database. But this did not scale well. What if the next request hit a different server? What if you have a zope server and a chat server, the login information would have to be transferred over. What if you have a micro services architecture? So by encrypting the login credentials, and storing them in a cookie, along with time to live information everything works much better. - -You can read the detailed documentation [here](./src/cromlech/sessions/jwt/test_session.txt). - -In general Cromlech has great detailed documentation, but it is all hidden in the -doc tests. So always look for it there. - - - From d3964d1a584389fe3e1e22504b6d4fbb2733b044 Mon Sep 17 00:00:00 2001 From: PythonLinks <34622952+PythonLinks@users.noreply.github.com> Date: Tue, 19 Dec 2017 06:34:57 +0100 Subject: [PATCH 4/4] Fixed title --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 029346a..28f02f4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ cromlech.sessions.jwt -##################### +====== + This packaged provides HTTP server side sessions using JWT and Cookies. JWT is way of encrypting a json file, so that it can be used for secure communications.