PyPI - ppss-auth - Versions diffs - 0.7__tar.gz → 0.7.2__tar.gz - Mend

ppss-auth 0.7tar.gz → 0.7.2tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (44) hide show

var/www/vhosts/pyramid.localhost.me/app/venv3/lib/python3.6/site-packages/ppss_auth/__pycache__/__init__.cpython-36.pyc ADDED Viewed

Binary file

var/www/vhosts/pyramid.localhost.me/app/venv3/lib/python3.6/site-packages/ppss_auth/__pycache__/constants.cpython-36.pyc ADDED Viewed

Binary file

var/www/vhosts/pyramid.localhost.me/app/venv3/lib/python3.6/site-packages/ppss_auth/__pycache__/models.cpython-36.pyc ADDED Viewed

Binary file

var/www/vhosts/pyramid.localhost.me/app/venv3/lib/python3.6/site-packages/ppss_auth/__pycache__/routes.cpython-36.pyc ADDED Viewed

Binary file

var/www/vhosts/pyramid.localhost.me/app/venv3/lib/python3.6/site-packages/ppss_auth/ppss_auth_utils/__pycache__/__init__.cpython-36.pyc ADDED Viewed

Binary file

var/www/vhosts/pyramid.localhost.me/app/venv3/lib/python3.6/site-packages/ppss_auth/ppss_auth_utils/__pycache__/password.cpython-36.pyc ADDED Viewed

Binary file

var/www/vhosts/pyramid.localhost.me/app/{venv/lib/python2.7 → venv3/lib/python3.6}/site-packages/ppss_auth/templates/layouts/masterlayout.mako RENAMED Viewed

@@ -25,6 +25,12 @@
 </head>
 <body class="ppss_auth">
 ${next.body()}
+<%block name="ppssauthfooterjs">
+<script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/js/bootstrap.min.js" integrity="sha384-JZR6Spejh4U02d8jOt6vLEHfe/JQGiRRSQQxSfFWpi1MquVdAyjUar5+76PVCmYl" crossorigin="anonymous"></script>
+</%block>
 </body>
-</html>
+</html>

var/www/vhosts/pyramid.localhost.me/app/venv3/lib/python3.6/site-packages/ppss_auth/views/__pycache__/__init__.cpython-36.pyc ADDED Viewed

Binary file

var/www/vhosts/pyramid.localhost.me/app/venv3/lib/python3.6/site-packages/ppss_auth/views/__pycache__/auth.cpython-36.pyc ADDED Viewed

Binary file

var/www/vhosts/pyramid.localhost.me/app/{venv/lib/python2.7 → venv3/lib/python3.6}/site-packages/ppss_auth/views/auth.py RENAMED Viewed

@@ -128,8 +128,8 @@ class AuthController():
     def login(self):
         r = self.request
-        postloginpage = self.request.referer if self.request.referer!=self.request.route_url("ppsslogin") else Conf.postloginroute
-        postloginpage = Conf.postloginroute
+        postloginpage = self.request.referer if self.request.referer!=self.request.route_url("ppsslogin") else r.route_url(Conf.postloginroute)
+        #postloginpage = Conf.postloginroute
         if r.POST:
             username = r.params.get("username",u"")
             password = r.params.get("password",u"")
@@ -141,7 +141,7 @@ class AuthController():
                 r.session['user'] = {'id':'1','name':'admin'}
                 headers = remember(r, u"1")
                 r.userid=u"1"
-                return HTTPFound(r.route_url(postloginpage),headers=headers)
+                return HTTPFound(postloginpage,headers=headers)
             res = PPSsuser.checkLogin(username,password,r.dbsession)
             if res:
                 l.debug("{username} logged in as normal user".format(username=username) )
@@ -149,7 +149,7 @@ class AuthController():
                 r.session['user'] = {'id':res.id,'name':username}
                 headers = remember(r, res.id)
                 r.session['principals'] = [str("g:"+group.name ) for group in res.groups  ]  #["g:user"]
-                return HTTPFound(r.route_url(postloginpage),headers=headers)
+                return HTTPFound(postloginpage,headers=headers)
             self.request.dbsession.query(PPSsuser).filter()
             l.warn("Login attempt failed for user {user}".format(user=username))
             return {'logintpl': Conf.publictemplateinherit ,'msg':'something went wrong with your login. Please check your informations'}

var/www/vhosts/pyramid.localhost.me/app/{venv/lib/python2.7/site-packages/ppss_auth-0.7-py2.7.egg-info → venv3/lib/python3.6/site-packages/ppss_auth-0.7.2.egg-info}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ppss-auth
-Version: 0.7
+Version: 0.7.2
 Summary: simple auth scheme for pyramid, based on Mako template and sqlalchemy backend
 Home-page: http://www.pingpongstars.it
 Author: pdepmcp
@@ -91,6 +91,121 @@ Description: This package aims to give and easy pluggable module to provide auth
+        # Things to know (devs only)
+        ## database
+        Thi package provide the creation and usage of 3 main tables (and the other tables required for ER consistency):
+        - ppss_user - containing basic information about the users (username, hashed password and related data )
+        - ppss_group - user groups to allow for easier handling of user groups and permissions
+        - ppss_permission - a list of permissions (just an id and a name)
+        ## models
+        ### PPSsuser
+        This represents the user of your application.
+        She has a _username_, a _password_ and relation to her _groups_. She also has a _enabled_ property and some timestamps (creation times, and similar times).
+        Use the _setPassword(password)_ method on PPSsuser instances to change the password, providing the new password.
+        _todict(self)_ is a commodity method to get a dict of the main properties.
+        ### PPSsgroup
+        This class represnts the groups of your users. It's a many-to-many relation: each user can belong to many groups, and each group can gather many users.
+        Other than a _name_ and the _enabled_ flag (integer with 1 for enabled), its main user is the many-to-many relation to permissions. This means that all users in the same group share (at least) all the permissions given to the group.
+        ### PPSspermission
+        This class represents the permissions of the application. You can create new permissions and link them to group. You can use those permissions in the _permission_ attribute of the _view\_config_ decorator to restrict usage of some methods using ACL, or you can check it whenever needed.
+        This package aims to give and easy pluggable module to provide authentication and user maintennance in a Pyramid web application.
+        It relies the Pyramid+SQLAlchemy+Mako stack. Implementation for other template languages is on the roadmap.
+        # Installation and setup
+        ## Install the package
+        Install the package with:
+        ```sh
+          pip install ppss_auth
+        ```
+        or put ppss_auth in your app dependencies (setup.py, in the install_requires list of packages)
+        To activate the package, in your main *\_\_init\_\_.py* file, inside the main function, add this line:
+        ```python
+          config.include('ppss_auth')
+        ```
+        in your models include the ppss_auth's models with this line:
+        ```python
+        from ppss_auth.models import *
+        ```
+        ## Configure the database
+        This can be a zero-db-conf module:
+        run the app with _ppss_auth.initdb_ set to True (that is the default for the params, so you can even leave it blank: see configuration, below). You are done with this, unless you need more in-depth initialization (follow reading)
+        ### You want to do it yourself
+        To init the Tables manually, in the initialization script (usually in *scripts/intializedb.py*), add this row:
+        ```python
+          from ppss_auth import (models as ppssmodels)
+        ```
+        and while creating the default data (in the "with transaction.manager" block of code), use something like:
+        ```python
+          ppssmodels.initdb(dbsession,createdefault=False)
+        ```
+        This creates the tables and, if *createdefault* evaulates to True, it create a default admin/admin user with the admin permission.
+        Please change the password to avoid secuirity issues.
+        You can create some data as well. Refer to [models] section, below, for more info.
+        ## Requirements
+        When a user login, *essionauthpolicy* is used to store her informations (userid and user groups).
+        ## ini file configuration
+        ppss_auth use these info from the ini file:
+        *default user*
+        - ppss_auth.adminname - the name of a sueruser. Deafult to "admin"
+        - ppss_auth.adminpass - the corresponding password. If not provided the admin is not allowed to log in (with the ini credentials. It may exist in database)
+        *db stuff*
+        - ppss_auth.initdb [True] - true/false value, tells the lib to init db automatically on first run.
+        *routes*
+        - ppss_auth.login_url [/login] - url for login.
+        - ppss_auth.logout_url [/logout]- url for logout.
+        *where to land after succesfull login/logout*
+        - ppss_auth.post_login_follow - try to redirect the browser back to where it came from after successful login (use true case insensitive to activate it). It's useful if combined with the forbidden pattern
+        - ppss_auth.post_login_route [home] - name of the route where to send the browser after user logged in. Ignored if ppss_auth.post_login_follow is set to true AND there is a referer to go to.
+        - ppss_auth.post_logout_route - name of the route where to send the browser after log out. Defaults to home
+        *templates stuff*
+        You can override all this values and even provide a mako-free environment. This can be a litlle tricky, but there is no hard-coded dependency to mako, just the defaults.
+        - ppss_auth.logintemplate - name of the login template. It defaults to the internal template: "ppss_auth:/templates/login.mako"
+        - ppss_auth.changepasswordtemplate - name of the change password template. Defaults to: ppss_auth:/templates/change.mako
+        - ppss_auth.modifyusertemplate - Defaults to: ppss_auth:/templates/modifyuser.mako
+        - ppss_auth.listusertemplate - Defaults to: ppss_auth:/templates/listuser.mako
+        - ppss_auth.logintemplateinherit - Defaults to: ppss_auth:/templates/layout.mako
         # Things to know (devs only)
         ## database
@@ -127,5 +242,5 @@ Classifier: Programming Language :: Python :: 2
 Classifier: Programming Language :: Python :: 2.7
 Classifier: Programming Language :: Python :: 3.6
 Classifier: Programming Language :: Python :: 2.7
-Requires-Python: >=2.7, >=3.6
+Requires-Python: >=2.7
 Description-Content-Type: text/markdown